javaSE基礎知識 1.1代碼註釋

本人第一次寫博客 但願大牛多多關照 若是有不對的地方請大牛指出  

本文章將會持續更新直到SE基礎結束爲止

前面JDK安裝和Eclipse安裝請百度查找進行下載，這裏JDK推薦1.8版本，1.8版本是一個已經完善的版本，安全性較高，1.8以後的版本也是基於1.8版本進行再次開發和拓展。

這個是JDK1.8的下載地址

https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

這個是Eclipse的下載地址

https://www.eclipse.org/downloads/

代碼的註釋與編碼規範

下面咱們來說一下代碼的註釋與編碼的規範由於合理的註釋和編碼規範能夠爲以後團隊等我的開發和維護時提供很好的方便

經過在代碼中添加註釋能夠提升代碼的閱讀性能夠幫助程序員更好的閱讀代碼 其中代碼是讓計算機識別的 例以下面這段代碼

上面這段代碼就是給計算機閱讀的，計算機會將咱們寫的代碼轉化成計算機能夠識別的字節碼，就向這樣1010的字節碼

其實呢，咱們寫的代碼是給程序員看的，因此呢程序員寫的代碼不只要計算機能讀你的程序，也須要其餘程序員能讀懂你的程序，若是你開發時看到的是這樣的代碼，或者你讓其餘人看你寫的這段代碼，無論哪一個人是不是初學者或者工做不少年，當他看到這段代碼的第一感受確定會瘋掉的

可是若是咱們給這段代碼加上註釋再給別人看的話，這時就一目瞭然了，這些代碼的每一行做用以及後期維護都帶來方便

有的初學者就會感受，我本身寫的代碼我本身看懂就好了，其實這是一個致命的錯誤，若是你寫的代碼不加註釋過了1個月，2個月，再讓你看這些代碼時你確定會說當時本身寫的是什麼鬼，在公司開發過程當中，開發人員和維護人員是分工協做的，當你寫的代碼亂糟糟的後期維護人員，維護時確定會瘋掉的，因此註釋是必不可少的

註釋是個好東西

註釋就是對代碼的解釋和說明，對每一處重要的代碼都要加一處註釋，其中有的人會擔憂本身的代碼有註釋會不會運行，放心，註釋範圍內的任何東西都不會被計算機進行編譯執行

註釋的三個種類

// 這種叫作單行註釋，這兩個//以後的東西都不會被計算機進行編譯執行
複製代碼

/*  
 這種叫作多行註釋，在兩個/*之間的內容都不會被計算機進行編譯執行
*/複製代碼

/**
* 這種叫作文檔註釋，文檔註釋通常對類中的方法和類進行文檔註釋，它也是一種多行的註釋
*/複製代碼

這三種註釋中，咱們最經常使用的呢就是前兩種註釋，單行註釋和多行註釋，這兩種註釋呢是幫助咱們調試程序，添加解釋說明的，第三種文檔註釋是幫助咱們生成幫助文檔的

下面咱們來看看這三種註釋，

這裏用了單行註釋就只輸出了5行 下面來看看多行註釋

這裏只輸出了3行 下面來看看文檔註釋

這裏呢，這個註釋是對這個類進行註釋說明，當實例化調用這個類時就會提示所說明的做用，方法上面的文檔註釋是對方法進行註釋說明