最佳做法。文件标准[非公开]

问题描述 投票:4回答:3

这里是问题,我需要为我们团队找到文档标准的思路。我们有几个需求,我们需要文档标准,用于 需求文件, 技术文件 - 为项目代码风格文档 - 对于开发者来说 其中会涉及到开发者应该如何命名,如何组织项目的代码(他是否应该使用区域?命名应该如何看?等等),我知道不同的项目可能会有不同,但也许有某种标准。目前每个开发者都是按照自己的想象来写的,这样不太好,因为不一致,而且风格不同等等。

我很好奇你们公司是怎么做的。也许有某种标准。

它应该怎么看?应该包括哪些内容等等。

另外我们使用的是.NET技术。

.net documentation standards
3个回答
10
投票

也可以参考微软开发类库的设计指南。http:/msdn.microsoft.comen-uslibraryms229042.aspx。


3
投票

这是一本非常好的书。《微软技术出版物风格手册》.


2
投票

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

一般文件标准

除了这些,还有一个很好的概述,在 www.codingthearchitecture.com

编码风格标准

除了上面提到的非常精美的 "微软开发类库的设计指南 "外,还有一些非常好的论据可以在 Linux内核编码风格指南,尽管那里给出的例子是在C。

© www.soinside.com 2019 - 2024. All rights reserved.