建站
咨詢
售后
建站咨詢
新聞中心
什么是注釋？如何在Java程序中加入注釋？
試想一下，一個沒有一句注釋的程序源碼，怎么讀，一個程序要上萬條代碼不可能全部記得住哪一塊是什么用，而且一個項(xiàng)目也不會是一個人獨(dú)自完成，那樣效率太低，多人合作就要給別人說明，每一塊是什么用，方便他人使用，方便自己更正，而這些說明文字就是注釋，注釋不會被執(zhí)行，不影響運(yùn)行結(jié)果。
阿魯科爾沁網(wǎng)站建設(shè)公司創(chuàng)新互聯(lián)建站,阿魯科爾沁網(wǎng)站設(shè)計(jì)制作，有大型網(wǎng)站制作公司豐富經(jīng)驗(yàn)。已為阿魯科爾沁上千多家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\成都外貿(mào)網(wǎng)站建設(shè)要多少錢，請找那個售后服務(wù)好的阿魯科爾沁做網(wǎng)站的公司定做！
Java中代碼的注釋有三種：
// 注釋一行?
/* ...... */ 注釋若干行?
/** ...... */ 注釋若干行，并寫入 javadoc 文檔
前兩種比較容易理解，至于第三種，你學(xué)習(xí)Java看的api文檔就是javadoc程序根據(jù)第三種的注釋生成的。
擴(kuò)展資料
注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時，寫程序的人給一個語句、程序段、函數(shù)等的解釋或提示，能提高程序代碼的可讀性。
java方法名前注釋問題
Java注解是附加在代碼中的一些元信息，用于一些工具在編譯、運(yùn)行時進(jìn)行解析和使用，起到說明、配置的功能。
注解不會也不能影響代碼的實(shí)際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。
1、元注解
元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四種。
1.1、@Retention: 定義注解的保留策略
@Retention(RetentionPolicy.SOURCE) //注解僅存在于源碼中，在class字節(jié)碼文件中不包含
@Retention(RetentionPolicy.CLASS) // 默認(rèn)的保留策略，注解會在class字節(jié)碼文件中存在，但運(yùn)行時無法獲得，
@Retention(RetentionPolicy.RUNTIME) // 注解會在class字節(jié)碼文件中存在，在運(yùn)行時可以通過反射獲取到
1.2、@Target：定義注解的作用目標(biāo)
@Target(ElementType.TYPE) //接口、類、枚舉、注解
@Target(ElementType.FIELD) //字段、枚舉的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法參數(shù)
@Target(ElementType.CONSTRUCTOR) //構(gòu)造函數(shù)
@Target(ElementType.LOCAL_VARIABLE)//局部變量
@Target(ElementType.ANNOTATION_TYPE)//注解
@Target(ElementType.PACKAGE) ///包
由以上的源碼可以知道，他的elementType 可以有多個，一個注解可以為類的，方法的，字段的等等
1.3、@Document：說明該注解將被包含在javadoc中。
1.4、@Inherited：說明子類可以繼承父類中的該注解。
如何寫好java代碼注釋
寫代碼的時候，有時候，你需要寫一些注釋，把內(nèi)容相互關(guān)聯(lián)起來，方便自己或別人看的時候，可以直接找到你關(guān)聯(lián)的代碼類或者啥的。
這個時候，{@link}與@see，這2個javadoc注解就派上用場了，
不管他具體有什么功能，咱就只管一個，他可以鏈接代碼，讓注釋看的更清楚易懂。方便你我他。
@see 標(biāo)簽允許用戶引用其他類的文檔。具體使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名稱
@see fully-qualified-classname#屬性名稱
我在使用的時候，發(fā)現(xiàn)這個只能單獨(dú)一行頂頭寫，如果不頂頭寫就不管用了，沒了鏈接的效果。
但是，{@link}這個卻可以隨便放。
具體使用方法和上面那個@see是一樣的。
實(shí)際效果，看下面的圖
java 怎樣給源代碼添加注釋
1、單行(single-line)--短注釋：//……
單獨(dú)行注釋：在代碼中單起一行注釋，
注釋前最好有一行空行，并與其后的代碼具有一樣的縮進(jìn)層級。如果單行無法完成，則應(yīng)采用塊注釋。
注釋格式：/*
注釋內(nèi)容
*/
行頭注釋：在代碼行的開頭進(jìn)行注釋。主要為了使該行代碼失去意義。
注釋格式：//
注釋內(nèi)容
行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進(jìn)行注釋。一般與代碼行后空8（至少4）個格，所有注釋必須對齊。
注釋格式：代碼
+
8（至少4）個空格
+
//
注釋內(nèi)容
2、塊(block)--塊注釋：/*……*/
注釋若干行，通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說明，或者算法的描述。一般位于一個文件或者一個方法的前面，起到引導(dǎo)的作用，也可以根據(jù)需要放在合適的位置。這種域注釋不會出現(xiàn)在HTML報告中。注釋格式通常寫成：
/*
*
注釋內(nèi)容
*/
3、文檔注釋：/**……*/
注釋若干行，并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符
/**......*/
...
網(wǎng)站題目：java代碼方法注釋,Java代碼注釋
網(wǎng)頁網(wǎng)址：http://www.dlmjj.cn/article/hdgsig.html
