ssh框架代码开发规范
1 代码开发规范 1.1 字符集规范 统一采用UTF-8，包括jsp、java文件。 1.2 注释规范 1.2.1 类注释 每个类注释都会被置于注释定界符/**...*/中，注释换行时用<br> 而不是用<p></p>，一个注释对应一个类或接口。该注释应位于声明之前，示例： /** * ClassName: 类名称<br> * Description: 类描述<br> * * @author 作者<br> * @date 日期 */ 注意：注释换行时用<br> 而不是用<p></p>，一个注释对应一个类或接口。该注释应位于声明之前 1.2.2 方法注释 方法注释，需要说明该方法的作用，声明参数类型、返回类型，声明所要抛出的异常，实例： /** * @MethodName: 方法名称<br> * @Description: 方法描述<br> * @param 参数说明<br> * @return 方法返回值说明<br> * @throws ServiceException 异常抛出说明 */ 1.2.3 变量注释 变量注释，采用单行注释符：// 1.2.4 业务代码注释 注意点：（1）关键业务要有注释 （2）算法要有注释 1.3 格式化排版 1.3.1 排版 代码格式统一按Eclipse默认的格式化排版，在代码上传svn前，一定要用Eclipse中的Ctrl＋shift