摘要:文件組織一個文件由應以空行分隔的部分和標識每個部分的可選注釋組成。一個文件超過行的代碼會顯得很麻煩,應該避免出現這樣情況。源代碼文件每個源文件包含一個多帶帶的公開類或者接口。構造函數方法這些方法應該按照功能而不是范圍或可訪問性進行分組。
3-文件組織
一個文件由應以空行分隔的部分和標識每個部分的可選注釋組成。
一個文件超過2000行的代碼會顯得很麻煩,應該避免出現這樣情況。
3.1 java 源代碼文件每個源文件包含一個多帶帶的公開類或者接口。如果這個公開類有關聯的私有類或者接口,可以把他們放在同一個文件里,必須放在公開類的下面。
java源文件的內容有以下幾部分:
頭部注釋(參考:)
包的聲明和導入聲明
類和接口聲明
3.1.1 頭部注釋所有源文件應以c樣式注釋開頭,其中列出了類名,版本信息,日期和版權聲明:
/* * 類名 * * 版本信息 * * 日期 * * 版權聲明 */3.1.2 包的聲明和導入聲明
大多數Java源文件的第一個非注釋行是一個package語句。之后,可以進行import語句。例如:
package java.awt; import java.awt.peer.CanvasPeer;3.1.3 類和接口聲明
下表按照它們應該出現的順序描述了類或接口聲明的各個部分。
順序 | 類和接口聲明 | 描述 | |
---|---|---|---|
1 | 類/接口 文檔注釋(/**...*/) | 參考 "文檔注釋" 了解該評論應該包含哪些內容。 | |
2 | 類/接口 聲明 | ||
3 | 類/接口的實現注釋(/*...*/), 可省略 | 這種注釋包含所有不適合放在類/接口文檔注釋的其他信息 | |
4 | 類(靜態) 變量 | 首先是public 類變量,然后是protected,然后是包級別(無訪問修飾符),最后是private。 | |
5 | 實例變量 | 首先是public 類變量,然后是protected,然后是包級別(無訪問修飾符),最后是private。 | |
6 | 構造函數 | ||
7 | 方法 | 這些方法應該按照功能而不是范圍或可訪問性進行分組。例如,私有類方法可以位于兩個公共實例方法之間。目標是讓閱讀和理解代碼更容易。 |
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/69354.html
摘要:它被稱為混合云文件系統,它使用本地部署的小型硬件客戶端來存儲文件元數據,并在后臺自動與云端同步。結論通過將本地部署環境的物理組件與云計算系統的組件相結合,混合云文件系統使組織能夠真正獲得兩全其美的優勢。如今,越來越多的企業正在將數據遷移到云中,以利用無需采購或維護大量硬件相關的成本、可擴展性和效率的優勢。事實上,云計算數據存儲當然可以幫助組織實現卓越的投資回報率。但是,通常在選擇僅云(clo...
摘要:第四章安全管理制度發布第十條安全管理制度必須以正式文件的形式發布施行。第十一條安全管理制度由信息安全管理小組制訂,信息安全領導小組審批發布。第二十條安全管理制度的修改與廢止須經信息安全領導組織審批確認,信息安全管理部門備案。 字數 3610閱讀 760評論 0贊 3《xxxx安全管理制度匯編》****制度管理辦法****文...
32單片機固件庫入門(當我們新建工程時…的各種配置和目錄結構)–學習筆記 一,關于keil5內部的一系列配置 由于下述代碼的存在 每次如果想要包含stm32f10x_conf.h 只需要包含#include stm32f10x.h語句,同時包含下述宏定義 #ifdef USE_STDPERIPH_DRIVER #include stm32f10x_conf.h#endif 該宏定義可以在IDE中...
閱讀 2072·2019-08-30 15:53
閱讀 3069·2019-08-30 15:44
閱讀 2916·2019-08-30 14:11
閱讀 2915·2019-08-30 14:01
閱讀 2701·2019-08-29 15:16
閱讀 3739·2019-08-29 13:10
閱讀 1243·2019-08-29 10:56
閱讀 2530·2019-08-26 13:58