2009-11-22 99 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.

非常精细的“微软设计准则类库开发”