注释代码
可能重复： 您是否对您的代码进行评论？ 我问，因为我和朋友正在创办一家公司，可能需要有一些商定的标准 解决方案 首先，注释应该清晰，简洁，相关到他们正在评论的代码，并提供通过实际阅读代码不容易获得的价值。例如，记录为什么选择特定散列算法而不使用其他可用于密码散列函数的散列算法。 如果您使用的是基于.NET的语言之一，为公共和私有成员使用XML注释，因为Visual Stu
..
comments相关内容
如何删除我的Facelets中的HTML注释？
我希望在向最终用户发送之前，从我的facelets中删除所有HTML注释。是否有任何标准方法？ 解决方案 实际有两种方法： 要删除所有评论，请将其添加到 web.xml ： javax.faces.FACELETS_SKIP_COMMENTS true
..
从C＃XML注释生成文档
我最近开始了一个新项目，我第一次使用C＃。我发现，虽然Visual Studio有助于创建C＃的XML注释来记录您的类和方法，但是没有太多可以做的来生成MSDN或Javadoc样式文档。 Google告诉我Visual Studio 2003包含一个用于生成此类文档的工具，但它不再包含在更高版本的IDE中。 如果我想使用我精心制作的（我向你保证！）XML标记，我的选择是什么？感谢您的答
..
Python文件的常见头格式是什么？
我在有关Python编码指南的文档中遇到了Python源文件的以下头文件格式： ＃！/ usr / bin / env python “”“foobar.py：foobar的说明。”“ __author__ =”Barack Obama“ __copyright__ =版权所有2009，地球“ 这是Python世界中标题的标准格式吗？ 我可以在标题中放置什么其
..
什么是快速的方式来评论/取消注释行在Vim？
我有一个在vi中打开的Ruby代码文件，有＃注释掉的行： class Search
..
C预处理器是否首先评论或扩展宏？
考虑这个（可怕的，可怕的，没有好的，非常糟糕的）代码结构： #define foo /注释掉调试代码 //错误格式化以不掩盖点 if（a） foo（a）; bar（a）; 我看到两个编译器的预处理器对此代码产生不同的结果： if（a） bar（a）; 和 if（a） ; bar（a）; 显然，这对于
..
Java - 在代码中查找注释的正则表达式
这次有点有趣。我想写一个程序，从标准输入（例如，逐行）读取代码，如： //一些注释 class Main { / * blah * / // / * foo foo（）; // foo * / foo2（）; / * // foo2 * / } 查找其中的所有评论并删除它们。我试图使用正则表达式，现在我做了这样的： private st
..
Python代码片段来删除C和C ++注释
我正在寻找Python代码，从字符串中删除C和C ++注释。 （假设字符串包含一个完整的C源文件。） 我意识到我可以使用正则表达式的.match（）子字符串，但是不解决嵌套 / * ，或在 / * * / // > 理想情况下，我更喜欢一个非天真的实现，可以正确处理尴尬的情况。 解决方案 我不知道你是否熟悉 sed ，这是基于UNIX的（但是Windows可用的）文本解析程序，
..
如何注释掉XML中的一组标签？
如何在XML中注释掉一个标记块？ 如何在以下代码中注释 及其中的一切内容？
..
“Except IE8”的条件注释？
我使用 来指定IE8，我想为所有浏览器加载EXCEPT IE8，我应该使用什么条件注释？ 编辑：我想知道这是否可以工作： ！ - [if lte IE 8]> 谢谢 解决方案 我可以想到一个诡计。在IE条件标签中设置一个变量，如果未设置该变量，则包含您的JS代码。
..
RegEx用于匹配/替换JavaScript注释（多行和内联）
我需要使用JavaScript RegExp对象从JavaScript源代码中删除所有JavaScript注释。 我需要的是RegExp的模式。 到目前为止，我发现这个： compressed = compressed.replace \ / \ *。+？\ * \ / | \ / \ /.*（？= [\\\ \r]）/ g，''）; 此模式适用于：
..
评论在Markdown
在markdown文件中存储注释的语法是什么？一个CVS $ Id $注释在文件的顶部？我在 markdown项目中找不到任何内容。 解决方案 我相信所有以前提出的解决方案（除了那些需要特定实现的解决方案）导致注释包含在输出HTML中，即使它们不显示。 如果你想要一个严格意义的注释（转换后的文档的读者不应该看到它，即使有“视图源”），你可以（ab）使用链接标签参考样式链接），它们在核
..
可以在DOCTYPE声明之前出现注释吗？
我想在HTML代码的最前面加上一个注释（ style），在DOCTYPE声明之前。这是否符合标准？是主流浏览器支持吗？ 解决方案 首先编写DOCTYPE是最好的做法。 我记得很奇怪的问题，很久很久以前，一些浏览器（可能是IE6）忽略了一个DOCTYPE，因为有一些看起来无辜的前面 - 我认为只是空白，但也许这是一个评论。在任何情况下，这是一个可怕的，可怕的错
..
从PHP代码中自动删除注释的最佳方式
从PHP文件中删除注释的最好方法是什么？ 我想做类似于strip-whitespace（）的操作 - 我想要这样：
..
字符串中的注释的正则表达式，注释中的字符串等
这是一个我已经解决并想以Q& A风格发布的问题，因为我认为更多的人可以使用解决方案。 你想在文本中使用引用的字符串和/或注释做一些事情。你想提取他们，突出他们，你有什么。但是一些引用的字符串在注释内，有时注释字符在字符串内。字符串分隔符可以转义，注释可以是行注释或块注释。当你认为你有一个解决方案有人抱怨，当它有一个正则表达式他的JavaScript不工作。什么？ 具体示例 va
..
在Python中创建多行注释的方法？
我最近开始学习 Python ，但我找不到如何实现多行注释。大多数语言都有块注释符号，例如 / * * / 我在Python中试过，但它抛出一个错误，所以这可能是不正确的方式。 Python实际上有多行注释功能？ 解决方案 可以使用三引号字符串。当他们不是一个docstring（类/函数/模块中的第一件事），它们被忽略。 这是一个多行的 注释。
..
什么是自我文档化代码，它可以替代记录良好的代码？
我有一位同事坚持认为他的代码不需要评论，而是“自我记录”。 我已经审查了他的代码，但我仍然不同意自我文档代码是完整和有用的，以及注释和文档化的代码。 帮助我理解 $ b 有没有例子，其中代码不可能是自我的 - 无文档记录 也许这只是我自己的限制，但我不知道它是一个好的做法。 p> 这不是一个参数 - 请不要提出为什么良好的注释和文档代码是高优先级 - 有很多资源显示这个
..
Xcode 5中提供了哪些新的文档命令？
Xcode 5的新功能之一是能够使用特殊注释语法记录您自己的代码。该格式与Doxygen类似，但似乎只支持这些功能的子集。 哪些命令受支持，哪些不支持？ 它们的用法与Doxygen不同吗？ 解决方案 下面是我在Xcode 5.0.2中找到的所有选项的示例 img src =“https://i.stack.imgur.com/RisSW.png”alt =“enter i
..
Outcommented Facelets代码仍然调用EL表达式（如＃{bean.action（）}），并导致＃{bean.action}上的javax.el.PropertyNotFoundException
我在Facelet中有以下代码片段： 它可以正常工作，但是当我这样排斥它时，
..
可以在JSON中使用注释吗？
我可以在JSON文件中使用注释吗？如果是，如何？ 解决方案 我不相信你可以有实际的评论。 你可以有一个指定的数据元素 “_comment”（或其他）使用JSON数据的应用程序可能会忽略。 生成/接收JSON的过程，因为他们应该知道提前的JSON数据，或者至少它的结构。 但如果您决定： { “_comment”：“comment text goes here ..
..