早上好,下午,晚上或晚上(取决于你的时区).
这只是C#中XML注释的一般问题.我从来没有非常大的评论我的程序,我一直更多的是一个详细的变量/属性/方法namer,让代码自己说.如果我正在编写一些相当混乱的东西,我会写评论,但在大多数情况下,我不会写很多评论.
我正在读取.NET中的XML注释,Sandcastle以及codeplex上的帮助文件构建器,它让我失望地想要记录我的代码,并为那些必须挖掘我的代码的人提供一些非常有用的文档当我不再在这里的代码
我的问题是关于标准和惯例.有没有指导“好”的XML评论？你应该注释每个变量和属性吗？每个方法？我只是基本上寻找如何撰写好的评论的提示,将由sandcastle编译成良好的文档,以便其他程序员最终不得不在我的代码上工作时,诅咒我的名字.
提前感谢您的意见和建议,
斯科特·维库斯基
