对于注释的要求

第一: 能够准确反应设计思想和代码逻辑
第二: 能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。
第三: 能自解释的代码就不要用注释

以下是常见的javadoc 注释

    /** 
     * show 方法的作用简述. 
     * ＜p＞show 方法的详细说明第一行＜br＞ * show 方法的详细说明第二行
     * @author 作者 (类)
     * @version 版本号(类)
     * @see 对类、属性、方法的说明  参考转向，也就是相关主题  
     * @param 参数名 参数描述 
     * @return 返回的内容 
     * @throws 异常类名
     * @Exception 
     */

方法内部单行注释，使用//注释。
方法内部多行注释使用/* */注释，注意与代码对齐。
所有的枚举类型字段必须要有注释，说明每个数据项的用途。
注释的描述,尽可能的简单,有力专有名词与关键字保持英文原文即可
特殊注释标记: TODO(还没实现的功能) （标记人，标记时间， [预计处理时间]); FIXME(不能工作) （标记人，标记时间， [预计处理时间])

注释的表述

注释代码段式应该注重’为何作’(why),而不是’怎么做’(How)
不准确 : /* 进行io读写操作 */
准确: /* 通过io读写得到XXX文件里的数据 */
使用专业术语
不准确 : /* 获取网络连接的状态 */
准确 : /* TCP 连接状态 */
注释数据声明:
1. 注释数值的单位
2. 对数值的允许范围给出注释
3. 注释编码含义
4. 注释对输入数据的限制
5. 注释’位标志’
6. 注释全局数据
7. 将于变量有关的注释通过变量名关联起来
注释控制结构:
1 应该在每一个if,循环,或者代码段前面加注释
2 应在每个冗长的控制结构之后加上注释
3 区分输入和输出的数据,用 in 或者 out 注释
4 对子程序的局限性,碰到麻烦的行为,就要注释

(1)Ctrl+Space

说明:内容助理。提供对方法,变量,参数,javadoc等得提示,
应运在多种场合,总之需要提示的时候可先按此快捷键。
注:避免输入法的切换设置与此设置冲突

(2)Ctrl+Shift+Space
说明:变量提示
(3)Ctrl+/
说明:添加/消除//注释,在eclipse2.0中,消除注释为Ctrl+\

(4)Ctrl+Shift+/
说明:添加/* */注释

(5)Ctrl+Shift+\
说明:消除/* */注释

(6)Ctrl+Shift+F
说明:自动格式化代码

(7)Ctrl+1
说明:批量修改源代码中的变量名,此外还可用在catch块上.

(8)Ctril+F6
说明:界面切换

(9)Ctril+Shift+M
说明:查找所需要得包

(10)Ctril+Shift+O
说明:自动引入所需要得包

(11)Ctrl+Alt+S
说明:源代码得快捷菜单。其中的Generate getters and setters 和 Surround with try/catch
block比较常用.建议把它们添加为快捷键.快捷键设置在windows->preferences->Workbench->Keys

2. 快捷键列表

编辑
作用域功能快捷键
全局查找并替换 Ctrl+F
文本编辑器查找上一个 Ctrl+Shift+K
文本编辑器查找下一个 Ctrl+K
全局撤销 Ctrl+Z
全局复制 Ctrl+C
全局恢复上一个选择 Alt+Shift+↓
全局剪切 Ctrl+X
全局快速修正 Ctrl1+1
全局内容辅助 Alt+/
全局全部选中 Ctrl+A
全局删除 Delete
全局上下文信息 Alt+？Alt+Shift+?Ctrl+Shift+Space
Java编辑器显示工具提示描述 F2
Java编辑器选择封装元素 Alt+Shift+↑
Java编辑器选择上一个元素 Alt+Shift+←
Java编辑器选择下一个元素 Alt+Shift+→
文本编辑器增量查找 Ctrl+J
文本编辑器增量逆向查找 Ctrl+Shift+J
全局粘贴 Ctrl+V
全局重做 Ctrl+Y

查看
作用域功能快捷键
全局放大 Ctrl+=
全局缩小 Ctrl+-

窗口
作用域功能快捷键
全局激活编辑器 F12
全局切换编辑器 Ctrl+Shift+W
全局上一个编辑器 Ctrl+Shift+F6
全局上一个视图 Ctrl+Shift+F7
全局上一个透视图 Ctrl+Shift+F8
全局下一个编辑器 Ctrl+F6
全局下一个视图 Ctrl+F7
全局下一个透视图 Ctrl+F8
文本编辑器显示标尺上下文菜单 Ctrl+W
全局显示视图菜单 Ctrl+F10
全局显示系统菜单 Alt+-

关于注释的说明和eclipse中的快捷键

对于注释的要求

猜你喜欢