标签: code-comments

我前段时间读过有关一种方法来评论一个css块的方法,你只需要删除注释字符集的一端,以防以后想要取消注释该块.

但我不记得它是如何完成的:(也许有人在这里知道:)

如果我们在.net中有太多注释代码会影响代码性能吗？

随机浏览了这个博客,关于如何永远不应该阅读评论,并且自己想到我读过的所有评论都是错误的,过时的,或者只是令人困惑.如果一个简单的永远不会读取评论和/或只是使用正则表达式替换模式来删除... :-) ...只是开玩笑,但真的,也许不是.至少看起来像评论和相关代码应该有时间戳.同意还是不同意？

仅供参考,博客似乎是由这个stackoverflow用户:Nosredna

修改现有代码时使用了哪些特殊技术？

例如:假设您修改方法中的业务规则.您是否使用特殊注释标记修改后的部分？

您在修改代码时使用的任何编码/注释标准？

我认为我们的源代码中有一堆注释掉的代码,而不是立即删除它们,我们刚刚离开它.现在我想做一些清理工作.

因此,假设我有一个足够好的RegEx来查找注释(下面的RegEx很简单,我可以根据我们的编码标准对其进行扩展),我如何获取我读取的文件的结果并输出以下内容:

• 文件名
• 电话号码
• 实际的代码行

我想我有一个答案的基础,但我不知道如何获取我已阅读并使用RegEx解析的文件并以此格式吐出.

我不是在寻找完美的解决方案 - 我只想找到大块注释掉的代码.通过查看结果并查看一堆具有相同名称和顺序行号的文件,我应该能够做到这一点.

$Location = "c:\codeishere"

[regex]$Regex = "//.*;" #simple example - Will expand on this...

$Files = get-ChildItem $Location -include *cs -recurse
foreach ($File in $Files) {
    $contents = get-Content $File
    $Regex.Matches($contents) | WHAT GOES HERE?
}

是否有一个工具(理想情况下基于命令行)可以帮助将源表转换为HTML表格(对于HTML表格来说可能是ASCII艺术),用于代码注释,如下所示？

例如,给定以下HTML表源

<TABLE BORDER=1>
  <CAPTION>A test table with merged cells</CAPTION>
  <TR><TH ROWSPAN=2><TH COLSPAN=2>Average
  <TH ROWSPAN=2>other<BR>category<TH>Misc
  <TR><TH>height<TH>weight
  <TR><TH ALIGN=LEFT>males<TD>1.9<TD>0.003
  <TR><TH ALIGN=LEFT ROWSPAN=2>females<TD>1.7<TD>0.002
</TABLE>

该工具将输出类似以下内容以嵌入代码注释(如/*…*/):

/*
          A test table with merged cells
+----------+-------------------+----------+--------+ 
|          |      Average      |  other   |  Misc  |
|          +---------+---------+ category +--------|
|          |  height |  weight |          |        |
|----------+---------+---------+----------+--------|
| males    |   1.9   |  0.003  |          |        |
|----------+---------+---------+----------+--------|
| females  |   1.7   |  0.002  |          |        |
+----------+---------+---------+----------+--------+
*/

背景:可以使用描述复杂HTML表格布局的基于文本的图形表示的注释来注释从HTML表中读取值的一段代码.稍后维护代码的人可以更容易理解,例如,一段代码如何切片和切割HTML表格或在某些单元格位置采集值.

如何保持源代码的良好记录/评论？是否有工具为Unix平台上的C++生成注释框架？

一般来说,对于包含大约100行代码的文件,建议使用多少行注释？

有没有办法以编程方式访问方法注释？或属性评论？

我想用它作为文档中方法的描述,我不希望它是静态的或用rdoc或等效的方法生成.

以下是Ruby类的示例:

Class MyClass
  ##
  # This method tries over and over until it is tired
  def go_go_go(thing_to_try, tries = 10) # :args: thing_to_try
    puts thing_to_try
    go_go_go thing_to_try, tries - 1
  end
end

基本上,我希望能够做到以下几点:

get_comment MyClass.gogogo # => This method tries over and over until it is tired

我有一个文本框,用户可以用脚本语言编辑文本.我已经想出如何让用户在一次点击中注释掉行,但似乎无法弄清楚如何正确地取消注释.例如,如果该框具有:

Normal Text is here
More normal text
-- Commented text
-- More commented text
Normal Text again
--Commented Text Again

Run Code Online (Sandbox Code Playgroud)

因此,当用户选择任意数量的文本并决定取消注释时,将从包含它的行的开头删除" - ".没有" - "的行应该不受影响.简而言之,我想要一个与Visual Studio中的类似的取消注释功能.有没有办法实现这个目标？

谢谢

好吧,如果我发表评论,它会在所有语言中被忽略,但是它们是如何被跳过的？

例:

// This is commented out

PHP现在读取整个注释以转到下一行还是只读取//？