标签: commenting

你如何在PowerShell(1.0或2.0)中注释掉代码？

我有一个批处理文件,它运行几个进行表修改的python脚本.

1. 我想让用户注释掉他们不想运行的1-2个python脚本,而不是从批处理文件中删除它们(所以下一个用户知道这些脚本作为选项存在!)

2. 我还想添加注释,以便特别注意它们在运行之前需要在批处理文件中更新的变量.我明白我可以用了REM.但看起来更像是在用户运行后更新用户的进度.

是否有更适当添加评论的语法？

您可以用什么方式在CoffeeScript中发表评论？

文档说您可以使用三个哈希符号来启动和关闭注释块:

###
  Comments
  go
  here
###

我发现我有时可以使用以下两种格式

`// backticks allow for straight-JavaScript,
 // but the closing backtick can't be on a comment line (I think?)
`

有没有更简单的方法在CoffeeScript中插入简短的注释？

不要使用这种风格**

由于这得到了很多观点,我想强调一下

/* Comment goes here */

当/*它在自己的行上时产生MATH错误.

正如特雷弗在对这个问题的评论中指出的那样,这是一个正则表达式,而不是评论!

我查看了JavaDoc参考,虽然我理解@see(各种链接)和{@inheritDoc}(超类JavaDoc注释的导出)之间的基本区别,但我需要澄清事情的实际实现方式.

在Eclipse IDE中,当我为继承的方法选择"Generate Element Comments"时(从接口或toString()覆盖等),它会创建以下注释

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

如果我需要产生的JavaDoc我应该离开它,取代@see用{@inheritDoc},或者把它真正的Javadoc这样的:

/**
 * {@inheritDoc}
 */

当我这样做时,我是否应该保持类#方法标志？

在Liquid模板语言中注释的正确方法是什么？

有没有在python中结束单行注释的方法？

就像是

/*This is my comment*/ some more code here...

我经常在Vim中同时评论几行,这种情况经常发生.我所知道的方法并不像TextMate那样快速地评论行.

你最喜欢的方式是什么？

我目前使用:

方法1:

• 转到第一行的char并使用blockwise visual mode(ctrl- v)
• 向下/向上,直到选择要注释掉的每一行的第一个字符
• 使用shift- i然后输入你的评论字符(#对于Ruby)
• 用于esc将注释字符插入每一行

方法2:

• 使用线性可视模式选择需要注释掉的行(shift- v)
• 类型:,它提供了一个:'<,'>可以扩展到的提示:'<,'>s/^/#/

方法3:

• 转到要注释的第一行
• 制作书签,例如打字 mm
• 转到要注释掉的最后一行
• 类型 :'m,.s/^/#/

我最喜欢方法1,但我仍然希望有更好的方法.

在Java文件中,我可以编写TODO注释,它们会显示在"任务"窗口中.

// TODO: Do something about this

但是,当我在例如SQL脚本和XML文件中编写TODO注释时,它们不会显示出来.有没有办法让他们这样做？例如:

-- TODO: Fix this SQL query

<!-- TODO: Fix this XML -->

我想知道如何/**/通过快捷方式发表评论.我知道评论的Ctrl+K+C快捷方式,//但它评论整条线.有时在调试时,我想ref string /* char[] */ lengthValue在尝试某些事情时做类似" "的事情.

我希望能够通过快捷方式评论一条线的特定部分(而不是整条线),例如在" string /* char[] */ lengthValue"中,即通过快捷方式仅注释掉类似的特定部分

我正在使用Visual Studio 2013

请帮忙

哪种评论方法被广泛接受或者真的重要？

我一直在用

/**  
 * (Method description)
 * @param
 * @return
 * etc
 */

不过我读过:

Precondition:
Postcondition:

是否有更"专业"的评论方式？