Java入門到精通個人筆記詳細(五)-------基礎支撐知識儲備(數據類型轉換、代碼規範)

數據類型轉換

  1. 隱式類型轉換

從低級類型向高級類型的轉換,系統將自動執行,程序員無須進行任何操作。

精度從低到高:byte <short <int <long< float <double

  1. 顯式類型轉換(強制類型轉換)

執行顯式類型轉換時,可能會導致精度損失。除布爾類型以外其他基本類型,都能以顯示類型的方法實現。當把整數賦值爲一個byte short int long 型變量時,不可以超過這些變量的取值範圍,否則必須進行強制類型轉換。

  1. 代碼註釋與編碼規範

代碼註釋是架起程序設計者與程序閱讀者之間的通信橋樑,最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以我們不是爲寫註釋而寫註釋。下面說一下我們在訴求網二期開發中使用的代碼註釋規範,供大家參考下。

原則:

1、註釋形式統一

在整個應用程序中,使用具有一致的標點和結構的樣式來構造註釋。如果在其它項目中發現它們的註釋規範與這份文檔不同,按照這份規範寫代碼,不要試圖在既成的規範系統中引入新的規範。

2、註釋內容準確簡潔

內容要簡單、明瞭、含義準確,防止註釋的多義性,錯誤的註釋不但無益反而有害。

註釋條件:

1、基本註釋(必須加)

(a)    類(接口)的註釋

(b)    構造函數的註釋

(c)     方法的註釋

(d)    全局變量的註釋

(e)    字段/屬性的註釋

 備註:簡單的代碼做簡單註釋,註釋內容不大於10個字即可,另外,持久化對象或VO對象的getter、setter方法不需加註釋。具體的註釋格式請參考下面舉例。

2、特殊必加註釋(必須加)

(a)    典型算法必須有註釋。

(b)    在代碼不明晰處必須有註釋。

(c)     在代碼修改處加上修改標識的註釋。

(d)    在循環和邏輯分支組成的代碼中加註釋。

(e)    爲他人提供的接口必須加詳細註釋。

 備註:此類註釋格式暫無舉例。具體的註釋格式自行定義,要求註釋內容準確簡潔。

 

註釋格式:

1、單行(single-line)註釋:“//……”

2、塊(block)註釋:“/*……*/”

3、文檔註釋:“/**……*/”

4、javadoc 註釋標籤語法

@author   對類的說明 標明開發該類模塊的作者, 每個作者對應一個標籤

@version   對類的說明 標明該類模塊的版本

@see     對類、屬性、方法的說明 參考轉向,也就是相關主題 一般ClassName是包括包名的全名

@param    對方法的說明 對方法中某參數的說明

@return   對方法的說明 對方法返回值的說明  一個參數對應一個標籤

@exception  對方法的說明 對方法可能拋出的異常進行說明 

或 @throws name description成員方法描述方法拋出的異常,每一個異常對應一個標籤
@data類/接口/方法用於顯示類,方法,接口具體創建時間,或者修改時間

@inheritDoc類/接口/成員方法繼承的文檔

{@link address} 或者

@ linkplain address text}類/接口/方法用於創建一個指向另一份文檔的超鏈接

@Time 2019年6月28日 22:15:22
{@link #hashCode()}

發佈了9 篇原創文章 · 獲贊 2 · 訪問量 1萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章