Tag: ndoc

用XML注释loggingC＃代码的最佳实践是什么？

我正在通过一些我刚刚写的新代码，并将NDoc sytle注释添加到我的类和方法中。 我希望能够生成一个非常好的MSDN样式文档以供参考。 一般来说，在为一个class级和一个方法写评论时有什么好的指导方针？ NDoc评论应该说什么？ 他们不应该说什么？ 我发现自己在看.NET框架的评论是什么，但是这个速度太快了; 如果我能有一些好的规则来指导自己，我可以更快地完成文档。