编码规范
1、总体规范
顶层包名:cn.com.todaysoft.js,所有的自建包都在此包下。
java文件必须带版权信息,比如:
/** * Copyright ? 2011 XXXX(XXX)XXXX Technology Co.,Ltd. * All right reserved. */
个人所建的包名、类名、成员变量名、参数名、方法名等,只要是其它类或方法所可能调用到的,必须有意义。
文件编码格式使用UTF-8。
每个类文件编写结束后,按一下
Ctrl+Shift+O 重新组织导入的包
Ctrl+Shift+F 格式化代码
有字串连接需求时,尽量使用StringBuffer 对象,少用String相加。
在必要时使用 synchronized ,使用时尽量在块级控制。
在必要时使用Vector类,尽量少用。
2、包命名
包的名字都是由小写单词组成。
3、类命名
类的名字尽量使用名词,单词的第一个字母大写,若出现缩写名称,则缩写字母全大写。如:TestPage,XMLExample。
4、方法命名
方法的名字尽量采用动宾结构词组,第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。如:sendMessge
5、常量命名
整个业务系统将要使用到的常量尽量定义到统一的常量类中,常量的名字应该都使用大写字母,多个单词时单词间用下划线隔开。如:MAX_VALUE。
6、JSP文件命名
采用完整的英文描述说明JSP所完成的功能,尽可能包括一个动词,第一个字母小写,如:viewMessage.jsp、editUser.jsp等。
7、变量命名
尽量缩小变量的作用域。
变量名第一个单词小写,后面的每个单词首字母大写。如:firstName,strFilePath。
变量命名建议使用前缀命名方式,如intWidth。
系统前缀缩写如下:
byte bye
char chr
float flt
boolean bln
Integer/int int
String str
Single sng
short sht
Long/long lng
Double/double dbl
Currency cur
8、注释
类和方法一定要有注释,说明用途,若代码在需求完成后有变动,则需要注明新修改的日期和内容。注释使用javadoc注释风格,格式在模板中已经给出,在程序编码过程中只需要按/**加上回车即可自动生成相应的类型方法注释。
eclipse设置
1、编码格式:
Window-->Preferences-->General-->Workspace, 在 workspace 下配置 text file encoding 的属性值是 other, 在 other 中选择 ”utf-8”, 配置完成后,点出 ok 保存。
Window-->Preferences-->MyEclipseàFiles and EditorsàJSP,在Encoding中选择ISO 10646/Unicode(UTF-8)。
2、显示行号
Window-->Preferences-->General-->EditorsàText Editors,将show line numbers勾上,或直接在行号位置按右键将show line numbers勾上。
3、一行显示的宽度
Window-->Preferences,在搜索框中输入formatt,在显示的左侧菜单中依次点入,查看formatting中带有line width的输入框,将里面的值改为140。搜索source,查看左侧标签,若右侧有Formatting,则将line width改成140。
4、设置快捷键
Window-->PreferencesàKeys,根据个人使用情况,我一般把Content Assist改成Alt+J,如果大家愿意可以改这个,当然里面都是快捷键,根据喜好大家自己设置。
5、导入code Templates
将codetemplates.xml文件中名字改成自己的名字
Window-->PreferencesàJavaàCode Styleàcode Templates,选择import,将codetemplates.xml导入。
6、导入js_todaysoft_formatter.xml
Window-->PreferencesàJavaàCode StyleàFormatter,选择Import,将js_todaysoft_formatter.xml文件导入。