记录.net代码的最佳方法是什么?
本文关键字：方法 是什么 最佳 net 代码 记录 | 更新日期: 2023-09-27 18:01:24
你我都知道为代码创建文档是一件很无聊的事情，所以我想让大家分享一下为代码创建文档的经验。
我认为项目文档不同于项目文档中的代码文档，您可以使用UML来描述整个项目，算法，设计，架构。但是，当您开发DLL库或提供web服务或其他将由其他开发人员使用的任何其他代码时，您的代码文档非常有效。我认为讨论的主题是:
1。您所知道的用于生成文档的工具
2。提供源文档的方法和规则
3。其他开发者的代码注释对你有用吗
这是社区普遍不同意的事情之一。一般来说……我想我们都承认代码文档是一件好事，但是我们怎么做是一个个人问题。
这是我的看法:
我知道这很痛苦，但是内联文档可以帮助您集中注意力，并为您提供一些信息，当您回顾代码时可以参考。
1)我使用Sandcastle从我的库生成帮助文件，我用XML文档注释来记录这些文件。
2a)始终为您的公共字段、属性和方法提供合理的XML文档。不要只写/// <summary>FieldName</summary>，描述这个字段是用来做什么的。
2b)谨慎使用内联注释。不要注释每一行，但是注释那些做了有趣的事情或以有趣的方式做的代码块，这样你(或其他人)下次阅读代码时就能清楚地理解它。
3) Abso-freaking-lutely。阅读我自己的代码通常很简单，但每个开发人员的工作方式不同。当你有一段别人写的代码时，注释可以决定你理解还是不理解。