SEBank银行项目文件编写规范

------------
Document: 文件编写规范
Description: 开发中产生的文件（包括源代码和文档）的编制说明
Created on: Nov 14, 2007, 2:01:42 AM
Author: 88250
Version: 1.0.0.0
------------------------------------------------------------------------




文档写文件头说明，格式如下：


------------
Document: 文件编写规范
Description: 开发中产生的文件（包括源代码和文档）的编制说明
Created on: Nov 14, 2007, 3:51:35 AM
Author: 88250
Version: 1.0.0.0
------------------------------------------------------------------------


正文部分....




代码注意编写文件头说明和类说明(JavaDoc)，格式如下


(1)
/*
* @(#)AccountRemote.java
*
* Copyright 2007 School of Software, Yunnan University.
* All rights reserved
*/
package cn.edu.ynu.sei.sebank.business;


import javax.ejb.Remote;


/**
* 帐户业务逻辑操作远程接口
* @author 88250
* @version 1.0.0.0, Nov 9, 2007
*/
@Remote
public interface AccountRemote
{
}






(2)
/**
* 用户数据访问对象的接口
*
* @author 88250
* @version 1.1.0, Nov 9, 2007
*/
public interface IUserDAO
{
}
其中版本日期使用Nov 9, 2007格式。另外，注释用中文的时候标点用中文的。
继承或实现方法标注 @Override，例如：
public interface IUserDAO
{
/**
* 更改用户密码
*
* @param userName
* 用户名
* @param password
* 密码
*/
public void changePassword(String userName, String password);
}


public abstract class UserDAO implements IUserDAO
{
@Override
public void changePassword(String userName, String password)
{
}
}


这个时候不写注释，但是如果是在子类里覆写抽象类的空方法的时候，必须标明子类的方法的特殊用途，也就是注释说明这个方法是针对这个子类的。



2. 其他规范情参考Sun的Java编码规范


http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

中文版本可参考《Java 语言编码规范（Sun）》