问题标签 [comments]

假设我有这个界面

而这堂课

有没有办法，或者有没有工具可以让我自动将每个成员的注释放入基类或接口中？

因为我讨厌为每个派生子类重写相同的注释！

常识告诉 Doxygen 注释块必须放在类、结构、枚举、函数、声明所在的头文件中。我同意这是一个合理的论点，因为库的意思是在没有源代码的情况下分发（只有标头和带有目标代码的库）。

但是......当我开发公司内部（或作为我自己的副项目）库时，我一直在考虑完全相反的方法，该库将与其完整源代码一起使用。我建议将大的注释块放在实现文件（HPP、INL、CPP 等）中，以免弄乱标头中声明的类和函数的接口。

优点：

• 头文件中的混乱更少，只能添加功能的分类。
• 例如，使用 Intellisense 时预览的注释块不会发生冲突 - 这是我在 .H 文件中有函数的注释块并且在同一个 .H 文件中有其内联定义时观察到的缺陷但包含在 .INL 文件中。

缺点：

• （显而易见的）注释块不在声明所在的头文件中。

那么，您有什么想法和可能的建议？

我正在尝试在我的 wiki 中创建一个评论部分。Web 上有一个解决方案涉及创建“列”，但这似乎只是在主要文章块下创建了第二个文本块。这是不切实际的，因为后续的编辑不会创建新的评论——它们似乎只是编辑现有的评论。外面还有几个人问这个问题。有没有人做过这样的事情？

哪些语言有副作用？本质上，评论不是评论......

我在注释代码时遇到的最常见的难题之一是如何标记参数名称。我将解释我的意思：

现在，我的问题是参数名称vector,width和n在该注释中没有以任何方式区分，并且可能与简单文本混淆。其他一些选项：

变形“矢量”以适应“宽度”。不超过'n'

或许：

变形 -vector- 以适应 -width-。不超过-n-

甚至：

变形 :vector: 以适应 :width:。不超过:n:

你明白了。像 Doxygen 这样的工具会强制执行此操作，但是如果我不使用工具怎么办？这种语言依赖吗？

你喜欢用什么？

背景：我们正在使用 VS 2008，并且正在从 TFS 2005 升级到 2008。

我们有一个包含多个项目的解决方案，并且总体上有数百个代码文件。我们想为所有这些文件添加相同的文本作为评论（版权信息）。有谁知道快速/简单/有效的方法来做到这一点？另外，有没有办法通过 TFS 做到这一点，所以我们没有签出和签入每个文件？

我在 CodeProject 上找到了一些关于创建执行此操作的宏的代码，但是您必须单独打开每个文件，然后在每个文件上运行宏，这是我们希望避免的。

谢谢。

在对克林贡语言进行了一些愚蠢的思考之后，来自这篇文章的我开始了一个愚蠢的爱好项目，创建一种可编译为 Lua 字节码的克林贡编程语言。在最初的语言设计阶段，我查找了有关克林贡程序员的信息，并发现了以下克林贡编程规则：

真正的克林贡战士不会评论他的代码！

所以我决定我的语言不支持评论，因为任何好的克林贡语都不会使用它们。

现在，对于我们人类程序员来说，许多克林贡方式似乎并不合理，但是在涉足我的爱好语言的设计和实现时，我开始意识到这条关于评论的克林贡规则确实非常合理，即使不是很好。

从编程语言中删除评论的能力意味着我必须编写有文化的代码，没有例外。

所以这让我想知道是否有任何语言不支持评论？

是否有任何真正好的论据可以不从语言中删除评论？

编辑：需要任何好的评论示例吗？

PS> 反正我上面的爱好语言有点傻，所以不要太关注我的实现，和一般需要的注释概念一样

我非常喜欢 Stack Overflow 评论 UI，我正在考虑在我自己的网站上实现同样的功能。我查看了代码，看起来这里的主要工具是WMD，而 JQuery TextArea Resizer起到了辅助作用。

WMD 在客户端将 Markdown 转换为 HTML。这非常好，因为它有助于预览，但是在将其发送到服务器时遇到了挑战。如果出现验证错误（比如用户在评论表单的其他部分输入了无效的电子邮件地址，或者他可能没有输入他的姓名），那么服务器会通过重新显示带有错误消息的表单和预先填充的表单字段。只是现在评论文本是 HTML，而不是 Markdown，因为服务器甚至从未见过 Markdown。但我希望它是 Markdown，因为这是用户输入的内容。

这里有什么想法吗？

我考虑了各种想法：

• 进行服务器端HTML 到 Markdown 的转换。对这个想法并不那么兴奋。从 Markdown 转换为 HTML 再转换回 Markdown 似乎很笨拙，作为用户，当软件重新格式化我的文本/代码时，我总是觉得它很烦人。
• 客户端验证（以增强服务器端验证，我当然会保留）。尽管目前我在评论表单上使用 reCAPTCHA，但这似乎是一个合理的方向，这意味着我至少需要将 reCAPTCHA 部分发布到服务器。
• 丢失 WMD 并使用MarkdownJ将 Markdown 转换为服务器上的 HTML。我需要寻找其他一些机制来完成我想要保留的预览功能。

理想情况下，除了 HTML 之外，还有一些方法可以获取文本的 Markdown 版本并将其提交到服务器，但我还不足以知道这是否是一个真正的可能性。

任何建议表示赞赏。

我遇到了删除表单注释的需要：

我想使用一个正则表达式来匹配开头和结尾“分隔符”之间的任何内容（包括换行符）。

这个任务的一个好的正则表达式是什么？

好的，我知道三引号字符串可以用作多行注释。例如，

和

但从技术上讲，这些是字符串，对吗？

我已经用谷歌搜索并阅读了 Python 样式指南，但我无法找到关于为什么没有正式实现多行、/* */ 注释类型的技术答案。我使用三引号没有问题，但我有点好奇是什么导致了这个设计决定。