问题标签 [comments]

有没有办法在页面中注释掉标记，.ASPX这样它就不会传递给客户端？我已经尝试过标准注释<!-- -->，但这只是作为注释传递，并不会阻止控件呈现。

您对评论的最佳做法是什么？什么时候应该使用它们，它们应该包含什么？或者甚至需要评论？

我的一些同事对他们的错误修复使用了特殊的评论，例如：

这有意义吗？
您是否以特殊方式评论错误修复？

请告诉我。

我习惯了 Atlas，其中首选（据我所知）方法是使用 XML 注释，例如：

最近我一直在研究其他第三方 JavaScript 库，我看到的语法如下：

作为奖励，是否有用于 JavaScript 的 API 生成器可以读取“首选”评论风格？

在编写“库”类型类时，最好总是在 java 中编写标记文档（即 javadoc）还是假设代码可以是“自记录”的？例如，给定以下方法存根：

javadoc 似乎是不言而喻的，如果功能发生变化，只需要更新噪音。但是关于冲洗而不关闭流的句子可能很有价值。

因此，在编写库时，最好：

a) 总是记录
b) 记录任何不明显的东西
c) 从不记录（代码应该自己说话！）

我通常使用 b)，我自己（因为代码可以是自记录的，否则）...

在Eclipse PDT，Ctrl-Shift-F重新格式化代码。但是，它根本不修改评论。有没有办法将参差不齐的多行注释重新格式化为每行 80 个字符（或其他）？

即转换

至

（我认为这也适用于常规 Eclipse。）

更新结果Eclipsein Javamode 将重新格式化上面的行，但前提是它们是 /* */ 样式的注释。它将缩短 // 太长的线，但不会将太短的线连接在一起。

对于那些看过 Reddit 源代码的人来说，它管理评论层次结构的逻辑到底在哪里？

我下载了代码，但甚至找不到数据库结构，更不用说读写评论的地方了。

如果有人在线程中途回复某人，它是否会更新大量评论？

有什么方法可以在您键入时自动将注释包装在 80 列边界处？..或者失败了，有什么方法可以在 coulmn 80 边界处显示一条微弱的线，以使手动包装它们更容易一些？

我使用的其他几个 IDE 具有这些功能中的一个或其他，它使编写包含在合理位置的注释更容易/更快。

[编辑]如果（像我一样）您使用 Visual C++ Express，则需要将密钥的 VisualStudio 部分更改为 VCExpress - 让我困惑了一会儿！

我已经看过其他问题，但我仍然对涵盖该主题的方式不满意。

我想在代码检查中提取一个精简的列表来检查注释。

我相信人们会说一些只会互相抵消的话。但是，嘿，也许我们可以为每个营地建立一个清单。对于那些根本不发表评论的人来说，这份名单会很短:)

我们都知道，注释我们的代码是编码风格的重要组成部分，它可以让下一个出现的人，甚至是我们自己在 6 个月左右的时间内都能理解我们的代码。

但是，有时评论并不能解决问题。我不是在谈论明显的笑话或发泄的挫败感，我说的是似乎试图解释的评论，但做得很糟糕，他们可能不在那里。太短、太神秘或完全错误的评论。

作为一个警示故事，您能否分享您所看到的确实很糟糕的东西，如果不是很明显，请显示它所指的代码并指出它有什么问题？那里应该放什么？

也可以看看：

• 何时不评论您的代码
• 你觉得你的评论怎么样？（最佳实践）
• 你在源代码中遇到过的最好的注释是什么？