c# - 注释代码 C# visual studio 最佳实践

Question

我正在寻找一个相当随意的答案，所以这可能更像是一个讨论。我想知道在 visual studio 中评论我的 C# 代码的最佳做法是什么。现在我正在使用三重///生成 xml 并使用沙堡来构建 chm 或 html 文件。但我的问题是我使用代码注释有两个原因:

1. 当其他开发人员使用我的代码时，他们可以阅读文档，包括 intellisence 和 chm。或 html 文件。
2. 但我也使用评论作为对自己的提醒。所以当我半年后回来时，我可以记住我的想法，一些复杂的方法。

如何在不相互干扰的情况下完成这两个目标，同时又是一个快速的任务，而不需要花费大量的编码时间？

Answer 1

我能给你的最好建议是:

Don't comment bad code; rewrite it!

如果方法非常复杂，那么大多数时候您都会做错事(并非总是如此，但几乎总是如此)。编写可读代码很难，但它是值得的，因为写出你(或你的大学)一年后会理解的好的评论也很难(甚至更难)。使事情变得清晰的方法是将方法分解为更小且命名良好的方法并使用非常清晰的变量名称。

一本对我编写更好的代码有很大帮助的书是 Robert Martins Clean Code .如果你还没有读过，请读一读。并让贵公司的所有开发人员阅读。

祝你好运。