2009-11-22 120 views
4

以下是問題,我需要爲我們的團隊查找/考慮文檔標準。我們有幾個需求,我們需要爲需求文檔技術文檔文檔標準 - 的項目代碼風格的文檔 - 開發商其中將包括開發者應該如何命名,並組織項目的代碼(他應該使用區域嗎?命名應該怎麼看?等等),我知道它可以因項目而異,但也許有一些標準。目前,每個開發人員都按照他的想象寫它,並不是那麼好,因爲它不一致,而且風格不同。等等。最佳實踐:文檔標準

我很好奇你/你的公司如何做到這一點。也許有一些標準。

它應該看起來如何?它應包含哪些內容?

順便說一下,我們使用.NET技術。

回答

9

布拉德·艾布拉姆斯幾年前貼在自己的博客微軟內部編碼準則的例子:還http://blogs.msdn.com/brada/articles/361363.aspx

請參見開發類庫http://msdn.microsoft.com/en-us/library/ms229042.aspx

+0

我喜歡內部的Microsoft編碼準則。有沒有完整版本?或者使用相同規則的類似文件? – 2009-11-22 12:47:54

+0

我認爲這是完整的版本 - 我不希望編碼指南包含更多 - 我們在工作中的長度相似。 – 2009-11-22 12:56:02

+0

看起來真不錯。但是技術和要求文件呢?他們的任何標準? – 2009-11-22 14:43:00

2

我有同樣的問題,並轉向IEEE找到一些標準。我發現下面的,我還沒有看,但相關性似乎:

通用文檔標準

除了這些,還有也是一個很好的概述在www.codingthearchitecture.com

編碼風格標準

除了上面提到的,還有一些在Linux Kernel Coding Style Guidelines可以找到很好的論據,雖然給出的例子還有在C.

非常精細的「微軟設計準則類庫開發」