问题标签 [comments]

有什么好的论据可以说服其他人评论他们的代码？

我注意到许多程序员更喜欢在没有注释的情况下编写代码的感知速度，而不是为自己和他人留下一些文档。当我试图说服他们时，我会听到半生不熟的东西，比如“方法/类名应该说明它的作用”等。你会对他们说些什么来改变他们的想法？

如果您反对评论，请留下评论。对于试图说服人们评论代码的人来说，这应该是一种资源，而不是其他方式。:-)

其他相关问题是：评论代码，您是否评论您的代码以及您希望您的评论如何。

我只是在查看 F#，如果这是一个愚蠢的问题，我深表歉意，但在 VS2008 F# CTP 1.9.6.2 'Tutorial' 项目中， // 和 /// 都用于注释代码。

两个斜线与三个斜线注释之间是否存在功能差异，或者是惯例（如教程代码中所示）用 /// 注释函数并使用 // 其他所有内容？

你在源代码中遇到过的最好的注释是什么？

多年来，当我完成学业并在该行业工作时，我经常向人们征求有关评论的建议。可悲的是，众所周知，与许多开发人员发表评论只是一种旁注，而不是其他东西。话虽如此，我通常会得到一个相当笼统的答案。确实，随着时间的推移，这对了解真正有帮助的东西并没有多大帮助。

那么，您认为使用 Visual Studio 构建 C# 的最佳方式是什么？

我有一个 wordpress 博客，并希望为人们在 stackoverflow 中添加评论提供相同的用户体验。那里有许多评论 ajax 插件，但我找不到一个可以让您在主页上内联、进入并添加评论而无需先深入到单独的单个帖子页面的工作。

任何人都可以在这里帮助使用 wordpress 插件或 php 代码来执行此操作。

是否可以在某处以某种方式添加评论？

在使用 MySQL 时，我不会假装自己是任何专家，当然也不会整天花在它上面。我经常忘记我打算如何使用列（通常是位列），如果我可以添加评论以提醒我 1 是好还是坏，我会非常兴奋。

如果它只出现在“显示创建表格”之类的内容中，我会很高兴，但表格结构中的任何模糊位置都会比我桌子上当前的便利贴更好、更容易找到。

我有一位同事坚持认为他的代码不需要注释，这是“自我记录”。

我查看了他的代码，虽然它比我看到其他人编写的代码更清晰，但我仍然不同意自文档代码与注释和文档代码一样完整和有用。

帮助我理解他的观点。

• 什么是自记录代码
• 它真的可以取代注释良好和记录良好的代码吗
• 是否存在比有据可查和注释的代码更好的情况
• 有没有代码不可能在没有注释的情况下自我记录的例子

也许这只是我自己的局限性，但我不明白它如何成为一个好的做法。

这并不是要成为一个论点 - 请不要提出为什么注释良好和记录良好的代码是高优先级的原因 - 有很多资源表明这一点，但它们并不能说服我的同行。我相信我需要更充分地理解他的观点才能说服他。如果必须，请提出一个新问题，但不要在这里争论。

另外，那些反对自我记录代码的人——这主要是为了帮助我理解自我记录代码传播者的观点（即积极的方面）。

我想在我的代码中添加注释，但我希望在部署之前将它们删除。是的，写这样的东西并不难，但是如果它已经存在的话……那么在 ASP 页面中的注释呢？

例如在 C# 或 JavaScript 文档中。
如果没有，在 ASP.NET 编程中使用Javadoc注释是否有意义？

因此，当我在 Visual Studio 中键入对我的 bValidateFields() 函数的调用时，智能不会显示我的评论。但是按照这个应该。应该是？