一、命名规范

•  尽量使用完整的英文描述符 
• 采用适用于相关领域的术语 
•   采用大小写混合使名字可读 
• 尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一 
• 避免使用长的名字（小于 15 个字母是个好主意） 
•  避免使用类似的名字，或者仅仅是大小写不同的名字 
• 避免使用下划线（除静态常量等） 

A. 包的命名

   包（Package） 采用完整的英文描述符，应该都是由小写字母组成。如hep.webapp.struts.actions。

B. 类的命名

   类（Class） 采用完整的英文描述符，所有单词首字母大写。如User, KnowledgeObject。

C.接口的命名

   接口（Interface）采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。一般在名字后面加上后缀 able。比如Flyable。

D.异常类的命名

 异常（Exception） 采用完整的英文描述符，所有单词首字母大写。通常在名字后面加后缀Exception。比如HepServiceException。

E. 变量命名

  变量字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。 如createTime。

F.方法命名

  采用完整的英文描述说明成员函数功能。第一个单词尽可能采用一个生动的动词，第一个字母小写，任何中间单词的首字母大写。如openFile(), findPassword()。

G. 静态常量

 全部采用大写字母，单词之间用下划线分隔。 如FOAF_PREFIX , ROOT_URL。

二、注释规范 

• 注释应该增加代码的清晰度
• 保持注释的简洁
• 在写代码之前写注释
• 注释出为什么做了一些事，而不仅仅是做了什么

A. 类注释

类声明前面注释类实现的主要功能、作者、版本、版权等信息。

/**
* operations to user foaf file
*
* @author yxm E-mail: yangxianmin8888@163.com
* @version OCT. 20, 2010 10:47:23 AM
*/
public class FoafService {

....}

B.成员方法注释

方法前面注释方法的主要功能、作者、参数、抛出的异常等信息。

/**
*
* @author qintai 功能：
* @param offset
* @param pageCapacity
* @param whereCondition
* @param orderBy
* @return
* @throws KeyNotFoundException
*/

D.方法内语句注释

单行注释,采用//后加一个空格，再开始注释信息。

deleteCollectedLC(); // 删除收藏的学习元

 所有的标记都必须要有一个相应的结束标记。如果是单独不成对的标签，在标签最后加一个"/"来关闭它。例如:<br /><img height="80" alt="网页设计师" src="../images/logo_w3cn_200x80.gif" width="200" />

所有标签的元素和属性的名字都必须使用小写。<div style="position:absolute;left:20px"></div>

所有的属性必须用引号""括起来。<td width=90%></td> 要改成 <td width="90%"></td>

所有的button使用标签<input type="button" value="编辑">不能使用<button>编辑</button>。

所有嵌入的js 方法，前面加javascript: ，比如<input type="button" value="检查" onclick="javascript: check();">，而不能使用<input type="button" value="检查" onclick="check();">。

写空链接时保持规范一点，不要写成<a href="#" >,统一调整为<a href="javascript:void(0)" > ；因为#会刷新页面，如果跟iframe有关联，可能会导致页面位置发生变化。

所有表格显示的页面其表格的名称列都定义为“居左对齐”。

例如，在“我创建的学习元”中“学习元名称”这一列就需要定义为“居左对齐”，如图所示：

在发送邮件的时候在自己的mailContent后加上一个方法的调用即可。

eg.  mailContent="学习社区管理员给您布置新任务了！"+MailService.getInstance().addSignature();