对日开发中的注释要求

java文件注释

java 代码

1. /**  
2.  *  
3.  * File Name: UserLogin.java<br>  
4.  *  
5.  * Created:     2007/09/13<br>  
6.  *  
7.  * Original Author: BBX <br>  
8.  *  
9.  */  

Class注释

java 代码

1. /**  
2.  *   
3.  * パッケージ名:jp.jal.logic<br>[译：package名：jp.jal.logic]  
4.  *   
5.  * クラス名：UserLogin.java<br>[译Class名：UserLogin.java]  
6.  *   
7.  * クラス概要:ユーザー登録画面ビン実装クラス<br>  
8.  *   
9.  * 作成者：XXXXX<br>  
10.  *   
11.  * 作成日:2007/09/13<br>  
12.  *   
13.  */  

变量注释

java 代码

1. // ユーザーのパスワード   
2. private String password;  

方法注释

java 代码

1. /**  
2.  * メソッド名:getUserlist<br>  
3.  *   
4.  * メソッド概要:ユーザー情報リストを取得する<br>  
5.  *   
6.  * @return String フォーワード文字列  
7.  *   
8.  * 作成日:2007/09/14  
9.  */  
10. public List getUserlist() {   
11.   
12.     // ユーザーリストを作成   
13.     userlist = new ArrayList();   
14.     // B処理DAOを初期化する   
15.     UserDao dao = new UserDao();   
16.     try {   
17.         // データソース接続の設定   
18.         dao.init();   
19.         // ログ出力   
20.         log.info("UserLogin----------------------->" + this.getId());   
21.         // ユーザーIDでユーザー情報リストを取得する   
22.         userlist = dao.getUserInfo(id);   
23.     } catch (Exception e) {   
24.         e.printStackTrace();   
25.     }   
26.     // ユーザー情報リスト   
27.     return userlist;   
28. }