问题标签 [comments]

背景：最近在查看“结构化文本编辑器”时，我注意到他们使用了一个技巧来更改 python/perl/c++/java 等。通过将 XML 潜入相应语言的注释中，形成一个“结构化”大纲。

我记得曾经在 Windows bat 文件中看到过这个技巧。bat 文件的 REM 语句用于“隐藏”一些 perl 代码。

问题：您是否见过有人使用编程或标记语言的注释来嵌入完全不同语言的语法的实例？如果是，您能否提供该示例的链接或解释它是什么？

如果你还没有，这里有一个例子：

• 使用此技巧的编辑器文件格式示例。

问题：这种“技巧”是一个聪明有用的想法吗？如果是这样，你能列举一个你使用这个技巧的特殊实例吗？如果不是，你能描述为什么你认为这是一个坏主意吗？

我意识到 Vim 中有一种隐藏/折叠行的方法，但我正在寻找的是一种选择文本块并让 Vim 在第 80 列或附近换行的方法。

大多数情况下，我想在向现有评论添加一些文本并将其推送超过 80 个字符的情况下将其用于评论。如果它也可以在换行时在行首插入注释标记，那就太好了。此外，我更喜欢不自动包装整个文件的解决方案，因为在将结构化代码保持在 80 个字符的行长以下时，我使用了一个特定的约定。

这主要用于 Python 代码，但我也有兴趣学习该问题的一般解决方案，以防我必须将其应用于其他类型的文本。

我正在尝试配置 emacs 以很好地缩进我的 C 块注释。

Emacs (22.3) 默认情况下（不管缩进样式）：

但我更喜欢的是：

我尝试使用 c-offset-alist 和语法符号“c”，但它并没有帮助我理解问题：

有任何想法吗？提前致谢！

干杯，丹尼尔

我试图阻止 Netbeans 打印这样的声明

无需从代码中删除它们。

Ruby 有块注释吗？

如果没有，是否有一种有效的方法可以#在 TextMate 中突出显示的代码块前面插入？

我正在使用 html-tidy，我的一些评论从文档的头部移到了根目录。有没有办法避免这种行为？

（我正在尝试将一些非常非常糟糕的标记转换为 xhtml 投诉代码）哦，另外它使用内部开发的半服务器端脚本语言，该语言使用注释在 html 中放置数据，非常非常非标准......我很想彻底改变它......但你知道雇主是如何......

这是问题所在：

整理前：

整理后：

如何自动将所有 C 样式注释 ( /* comment */) 替换为 C++ 样式注释 ( // comment)？

这必须在几个文件中自动完成。任何解决方案都可以，只要它有效。

有时真的很难决定你什么时候写了足够多的评论让别人理解你的意图。

我认为人们需要更多地专注于编写可读、易于理解的代码，而不是包含大量注释来解释发生的每一个细节。

您对此有何看法？

我曾经在 C++ 中使用 doxygen lot，并且非常喜欢使用///<或变体来内联记录函数和方法参数的能力。相反，我真的不喜欢在不使用内联样式时必须在注释中重复参数（因为大多数代码文档系统仅支持）。

所以最近我一直在用我的 Objective-C 代码设置 doxygen，并且似乎无法让内联参数记录工作！

使用@param 的离线文档似乎有效——所以我只能得出结论，它不支持内联Objective-C 方法语法。这将是一个真正的耻辱。

有没有人知道有什么不同？我很想让这个工作。

根据文章，我刚刚考虑了将评论存储在数据库中的最佳方法，并带有适当的数字。

这个想法是使用复合主键（commentId，articleId）存储评论，其中commentId是根据给定的articleId生成的。生成系统应该和SQL Server中IDENTITY生成列的原理一样，因为如果有人删除了评论，这个数字就再也不会被使用了。我想 Microsoft SQL Server 中没有任何功能可以使用复合 PK 来做到这一点，所以我想问一些替代这个解决方案的方法。

首先想到的是使用事务来获取 MAX(commentId) + 1，但我正在寻找更抽象的东西（可能是 INSTEAD OF 触发器），例如可以在不了解背景的情况下在 LINQ 中使用的东西，只需插入适当的表所有必需的值（所以没有commentId）并保存它。