ASP .Net 项目中的代码注释答案

【问题标题】：Code comments in a ASP .Net projectsASP .Net 项目中的代码注释
【发布时间】：2011-01-07 09:25:13
【问题描述】：

我过去常常在较小的项目上工作，我通常是唯一的贡献者，但现在我正在从事一个 ASP .Net C# 项目，其他人稍后将使用我的代码。

我相信我确实以专业的方式评论了我的 C# 代码，但我从来没有费心在我的 ASPX 页面中编写 cmets，除了 JavaScript 代码。

有没有 ASP .Net 开发人员使用的“标准”？

我是否在 cmets 中放入有关 Code Behind 中生成的操作的信息以简化页面阅读，还是这样做有点矫枉过正？

谢谢，斯蒂芬

【问题讨论】：

【解决方案1】：

努力实现自我记录的代码（需要更少的 cmets）。

遵循常见模式（内部或行业）

（谨慎地）使用“高级 Intent”的 cmets 来解释不明显的代码。

【讨论】：

我会使用“非显而易见的代码”：抽象概念和算法。我的意思是你确实想要记录没有改变的事情以及你实际在做什么而不是代码做什么。代码告诉你它做了什么，cmets 告诉你你想让它做什么并且不应该改变。
@Tomas Jansson：是的，我就是这个意思。注意到并更新。谢谢

【解决方案2】：

了解什么是（可能的）需要解释，如果被其他人看到。使用 GhostDoc 插件快速编写 cmets，但请记住验证插件编写的 cmets。评论应该是不言自明的。

【讨论】：

GhostDoc 不支持 ASPX/HTML/XML 中的注释
是的，它没有。然而，HTML 更容易理解，否则无论如何你都可以放置 cmets。不建议使用 HTML 中的注释，因为它会增加页面大小并进入用户浏览器（可能会降低您的隐私），但有时可能对某些爬虫有用。如果您需要放置一些敏感信息，请使用服务器端 cmets