Tim*_*ley -1 c# commenting visual-studio
多年来,当我经历过学校并在该行业工作时,我经常向人们征求评论意见.遗憾的是,众所周知,与许多开发人员进行评论是一个侧面说明,而不是其他内容.话虽如此,我通常得到一个相当一般的答案.真的,这对于了解随着时间的推移真正有用的东西并没有太大帮助.
那么,您认为使用Visual Studio构建C#的最佳方式是什么？
至少,我会使用三斜杠XML注释块来评论公共API的所有部分.这将使得在时机成熟时自动生成文档变得容易.
除此之外,我会评论在六个月内难以破译的任何特定算法或代码片段.这种"自私"的评论方法(即假设您以后必须维护此代码)通常可以在没有过度杀伤的情况下实现充分文档的最佳平衡.