首頁> Java> java教程> 主體

淺談JAVA開發之java專案命名規範

无忌哥哥
發布: 2018-07-18 11:54:45
原創
1901 人瀏覽過

一、命名規格

1、 項目名稱全部小寫

2、 套件名稱全部小寫

3、 類別姓名縮寫,若類別名稱由多個字組成,每個單字的首字母都要大寫。

如:public class MyFirstClass{}

4、 變數名稱、方法名稱縮寫,如果名稱由多個單字組成,每個單字的縮寫都要大寫。

如:int index=0;

public void toString(){}

#5、 常數名全部大寫

如:public static final String GAME_COLOR=”RED”;

6、所有命名規則必須遵循以下規則:

1)、名稱只能由字母、數字、底線、$符號組成

# 2)、不能以數字開頭

3)、名稱不能使用JAVA中的關鍵字。

4)、堅決不允許出現中文及拼音命名。

二、註解規格

1、 類別註解

#在每個類別前面必須加上類別註釋,註解範本如下:

/** * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd. * FileName: Test.java * 类的详细说明 * * @author 类创建者姓名 * @Date 创建日期 * @version 1.00 */
登入後複製

2、屬性註釋

在每個屬性前面必須加上屬性註釋,註釋模板如下:

/** 提示信息 */ private String strMsg = null;
登入後複製

#3、 方法註釋

在每個方法前面必須加上方法註釋,註釋模板如下:

/** * 类方法的详细使用说明 * * @param 参数1 参数1的使用说明 * @return 返回结果的说明 * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明 */
登入後複製

4、 構造方法註釋

在每個建構方法前面必須加上註釋,註釋模板如下:

/** * 构造方法的详细使用说明 * * @param 参数1 参数1的使用说明 * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明 */
登入後複製

5、 方法內部註解

在方法內部使用單行或多行註釋,此註解依實際情況新增。

如://背景顏色

Color bgColor = Color.RED
登入後複製

以上是淺談JAVA開發之java專案命名規範的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
最新問題
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!