Java基礎中注釋添加的位置以及原則詳解

　　1.添加注釋的位置

　　(1)類，接口

　　這一部分注釋是必須的。在這里，我們需要使用javadoc注釋，需要標明，創建者，創建時間，版本，以及該類的作用。

　　(2)方法

　　在方法中，我們需要對入參，出參，以及返回值，均要標明。

　　(3)常量

　　對常量，我們需要使用多行注釋，進行標明該常量的用途，如下所示:

　　(4)關鍵算法上

　　在關鍵算法上，添加注釋并且按照順序依次標明，寫明白該方法為什么這么做。

　　2.添加注釋的原則

　　(1)注釋形式統一

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

　　(2)注釋內容準確簡潔

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

　　在之前的文章中學習了不少關于java注釋的方式以及快捷操作，有些人還不清楚應該注釋的位置，以及注釋時需要注意的原則。注釋位置為類，接口、方法、常量、關鍵算法，原則有注釋形式統一和注釋內容準確簡潔。以上就是我們在Java基礎中注釋添加位置以及原則的詳解，學會了的小伙伴在使用java注釋時一定要時時牢記，本篇內容到這里就結束啦。

　　推薦操作環境：windows7系統、java10版，DELL G3電腦。

　　更多關于“Java培訓”的問題，歡迎咨詢千鋒教育在線名師。千鋒已有十余年的培訓經驗，課程大綱更科學更專業，有針對零基礎的就業班，有針對想提升技術的好程序員班，高品質課程助力你實現java程序員夢想。