.net 最佳做法:文件标准

.net 最佳做法:文件标准,.net,documentation,standards,.net,Documentation,Standards,这就是问题所在,我需要找到/思考我们团队的文档标准。我们有几个需求,我们需要需求文档的文档标准,项目的技术文档-,开发人员的代码风格文档-,这将涵盖开发人员应该如何命名和组织项目代码(他应该使用区域吗?命名应该是什么样子?等等),我知道每个项目都会有所不同,但可能有一些标准。目前每个开发人员都按照自己的想象编写,但这并不太好,因为它不一致,风格不同等等 我很好奇你/你的公司是如何做到这一点的。也许有某种标准 应该是什么样子?应该包括什么内容?等等 顺便说一句,我们使用.NET技术。另请参见Mic

这就是问题所在,我需要找到/思考我们团队的文档标准。我们有几个需求,我们需要需求文档的文档标准项目的技术文档-开发人员的代码风格文档-,这将涵盖开发人员应该如何命名和组织项目代码(他应该使用区域吗?命名应该是什么样子?等等),我知道每个项目都会有所不同,但可能有一些标准。目前每个开发人员都按照自己的想象编写,但这并不太好,因为它不一致,风格不同等等

我很好奇你/你的公司是如何做到这一点的。也许有某种标准

应该是什么样子?应该包括什么内容?等等


顺便说一句,我们使用.NET技术。

另请参见Microsoft开发类库的设计指南。

这是一本非常好的书:。

我也遇到了同样的问题,并向IEEE寻求一些标准。我发现了以下内容,我还没有读过,但似乎很相关:

一般文件标准
除此之外,还有一个很好的概述

编码风格标准
除了非常好的“Microsoft类库开发设计指南”如上所述,在中可以找到一些非常好的论据,尽管在C中给出了示例。

我喜欢Microsoft内部编码指南。是否有完整版本?或使用相同规则的类似文档?我认为这是完整版本-我不希望编码指南包含更多内容-我们正在使用的一个是相似的长度。看起来真的很不错。但是技术和要求文档呢?有什么标准吗?我从来没有见过任何技术或要求文档的标准-项目之间需要这些文件的级别差异很大-医疗和安全关键项目的要求可能需要记录到与简单商业应用程序的级别不同。404。不幸的是,链接已失效。有人带来了新链接,请。。。