早上好,下午,晚上或晚上(取决于你的时区).
这只是C#中XML注释的一般问题.我从来没有非常大的评论我的程序,我一直更多的是一个详细的变量/属性/方法namer,让代码自己说.如果我正在编写一些相当混乱的东西,我会写评论,但在大多数情况下,我不会写很多评论.
我正在读取.NET中的XML注释,Sandcastle以及codeplex上的帮助文件构建器,它让我失望地想要记录我的代码,并为那些必须挖掘我的代码的人提供一些非常有用的文档当我不再在这里的代码
我的问题是关于标准和惯例.有没有指导“好”的XML评论？你应该注释每个变量和属性吗？每个方法？我只是基本上寻找如何撰写好的评论的提示,将由sandcastle编译成良好的文档,以便其他程序员最终不得不在我的代码上工作时,诅咒我的名字.
提前感谢您的意见和建议,
斯科特·维库斯基
就个人而言,我们确保每个公共和受保护的方法都有XML注释.它还将为您提供Intellisense,而不仅仅是最终用户帮助文档.在过去,我们也把它包括在私有范围的声明中,但是不要紧,只要方法是短暂的,就不用说了.
不要忘记,有工具可以使您的XML注释任务更容易：
> GhostDoc – 评论继承和模板加载项.
> Sandcastle Help File Builder – 通过GUI编辑Sandcastle项目,可以从命令行(用于构建自动化)运行,并且可以编辑MAML以获取不从代码派生的帮助主题. (1.8.0.0 alpha版本非常稳定,非常完善,现在使用了大约一个月,超过1.7.0.0)
原文地址：https://www.jb51.cc/xml/292923.html
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。
