1. 程式人生 > 實用技巧 >說說程式碼中的註釋

說說程式碼中的註釋

*what:

註釋,也是解釋,標記。程式碼中的註釋不會被執行!

*why:

方便提醒自己,這程式碼代表的是什麼功能?當代碼量很大的時候,非常有用。

當然,平時寫程式碼就得規範,規範寫註釋。大廠都要求的。

*how:

  • 單行註釋,雙斜槓,//,快捷鍵是:ctrl + /

  • 多行行註釋,/ * * /,如:/* 我是多行註釋,巴拉巴拉*/,快捷鍵:ctrl + shift +/

  • 文件註釋,/ *** /,多了個 *,在第二個 * 後面開始寫註釋,配合@,寫一些資訊,如@author,一般結合juc併發程式設計使用,javadoc生成文件。小公司用得少,大公司多。

在方法名前註釋功能,在關鍵程式碼上註釋!


關聯:

註釋跟註解是差別的。以後補上,說明

案例:

註釋,其實可以類比為小學自己在書本上的筆記,在英文旁邊的中文翻譯。

搜尋“有趣的程式碼註釋”,可以發現很多驚喜!


@程式碼:

示例