大家都有哪些好用的代码注释方法

Question

有时候需要注释掉一段代码，常用的下面两种：

// 适合注释单行代码

/*
适合注释段落代码
适合注释多行连续的代码
*/

对于第二种，在注释和取消注释频的段落每次都得删除和输入，很麻烦，不知道大家有没有好的方法？

Answer 1

第二种我一般用这种方式

/**
 * 适合注释段落代码
 * 适合注释多行连续的代码
 */

Answer 2

原先看过一种代码注释方法，很适合调试：

/** *
适合注释段落代码
适合注释多行连续的代码
**/

如果你要恢复被注释掉的代码，直接加两个/就可以了

/** */
适合注释段落代码
适合注释多行连续的代码
/**/

Answer 3

用vim的话可以有注释插件,几个快捷键就搞定,

Answer 4

就用 //
在文件头或者函数头那个地方需要的话可以用 /* */
反正注释写得太多，肯定是没有美感的，代码还是要简单一点。
喜欢写文档让别人清楚的，可以用doxgey之类的东西。

Answer 5

注释一段的话还是用第二种吧
用IDE的话这个问题也倒无所谓，不过用类记事本编辑器的话还是得手动删除

Answer 6

python docstring

''' comment '''

#or comment

'''
and comment
'''

Answer 7

Java有JavaDoc规范，PHP有PHPDoc规范，Python 有DocString 内部注释还是 // 方便。举个栗子(PHPDoc的)：

/**
 * 创建Entity，支持三种调用方式：<pre>
 * _	1、 new XxxEntity()		用于新建一个Entity，对应INSERT操作
 * _	2、 new XxxEntity('id',1)	用于从数据库加载一个id=1的新对象，对应 SELECT 操作
 * _	3、 new XxxEntity($rowData)	主要用于对IDatabaseConnection 返回的数组进行封装
 * </pre>
 * 注意：筛选字段 <b>应该</b> 是数据表中的PRIMARY KEY或者 UNIQUE KEY
 * @param array $rowData  原始数据（可选）
 * @param array $keyField  筛选字段
 * @param array $keyValue  筛选值
 * @throws Exception 转换失败将抛出异常
 */

Answer 8

Perl (the Plain Old Documentation format)

=pod

xxxxx

=cut

Answer 9

不同的IDE应该都有快捷键的，visual studio支持ctrl+*实现第二种注释/取消注释，eclipse和vs都支持第一种注释的快捷键ctrl+/，其它IDE可以自己探索一下~ 有快捷键还是很方便的~