代码注释的说明

0. eclipse 代码注释

• alt + shift + j：自动添加文档注释（作者，时间等）
  
  • 模板注释自然是可以编辑和定制的；

1. 注释的对象

• 注释变量：
  
  • 变量的意义，存储的是什么内容；
  • 尤其对面向对象的编程语言，成员变量的具体含义；
• 注释函数：
  
  • 函数名
  • 函数功能的说明
  • 参数及返回值的说明

2. 注释的位置

• 注释置于代码之上：注释在代码之前，先看到注释后看到代码；
• 注释置于代码之后（之右）：先看到代码，再看到注释；

3. 杂项

• Tricks（四十八）—— 注释一段代码