java項目命名規范


 

 

https://blog.csdn.net/chao2016/article/details/79370658#1%E9%A1%B9%E7%9B%AE%E5%90%8D

 

1、項目名

  • 全部小寫。如:workdesk、jobserver。

2、包名

  • 全部小寫,名詞。如:java.awt.event。

3、類名、接口名

  • 首字母大寫,多個單詞組成時,每個單詞的首字母大寫。如:
public class MyClass {}

 

4、方法名

  • 首字母小寫,多個單詞組成時,從第二個單詞開始,每個單詞的首字母大寫。第一個單詞一般為動詞,如:
public void toString() {}

  

5、變量名

5.1 普通變量名

  • 同方法的命名,一般為名詞。如:
int index=0;

  

5.2 常量名(靜態變量名)

  • 全部大寫。如:
public static final String GAME_COLOR=”RED”;

  

 

6、屬性文件properties

  • 以下划線隔開。如:errors_zh_CN.properties,hibernate_test.properties

7、數據庫命名:

  • 表、字段命名全部大寫,多個單詞以_隔開

8、注釋規范

8.1、類注釋

  • 在每個類前面必須加上類注釋,注釋模板如下:
/**
* Copyright (C), 2006-2010, Anhui Love info. Co., Ltd.
* FileName: Test.java
* 類的詳細說明
*
* @author 類創建者姓名
* @Date    創建日期
* @version 1.00
*/

  

8.2、屬性注釋

  • 在每個屬性前面必須加上屬性注釋,注釋模板如下:
/** 提示信息 */
private String strMsg = null;

  

8.3、方法注釋

  • 在每個方法前面必須加上方法注釋,注釋模板如下:
/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 返回結果的說明
* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/

  

8.4、構造方法注釋

  • 在每個構造方法前面必須加上注釋,注釋模板如下:
/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/

  

8.5、方法內部注釋

  • 在方法內部使用單行或者多行注釋,該注釋根據實際情況添加。如:
//背景顏色
Color bgColor = Color.RED

  

 
       


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM