導航:首頁 > 編程語言 > java注釋設置
java注釋設置
發布時間：2022-04-25 22:25:37❶ java文件怎麼配置多行注釋
您好，提問者：
可以在配置管理-->搜索：keys進行配置。
單行注釋：Alt+/
多行注釋：選中 Ctrl+Shift+/
❷ 如何在Java中使用注釋
java中的注釋與大多數編程語言是一樣的
// 雙斜杠，表示注釋一行語句
/* */ 多行注釋
當然，還有文檔注釋： /** */
❸ 如何為JAVA程序添加註釋
有三種注釋方法
單行注釋：在代碼後面 打出 //
多行注釋 /* */
文檔注釋 /** */
❹ java中的注釋可分為三種類型
Java中三種類型的注釋：
單行注釋：// 注釋內容
多行注釋：/*... 注釋內容....*/
文本注釋：/**.. 注釋內容....*/
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以不是為寫注釋而寫注釋。
備註：簡單的代碼做簡單注釋，注釋內容不大於10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加註釋。
(4)java注釋設置擴展閱讀：
類（模塊）注釋採用 /** …… */，在每個類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號；命名空間；類可以運行的JDK版本；版本號；作者；創建時間；類（模塊）功能描述（如功能、主要演算法、內部各部分之間的關系、該類與其類的關系等，必要時還要有一些如特別的軟硬體要求等說明）；主要函數或過程清單及本類（模塊）歷史修改記錄等。
❺ java 中的幾種注釋方式
我看動力節點的java基礎大全301集教中的三種注釋方法：
1、單行注釋 //注釋的內容
2、多行注釋/*......*/
3、/**......*/，這種方式和第二種方式相似。這種格式是為了便於javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記：
特別聲明：
（1）javadoc針對public類生成注釋文檔
（2）javadoc只能在public、protected修飾的方法或者屬性之上
（3）javadoc注釋的格式化：前導*號和HTML標簽
（4）javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應用：
（1）首先編寫.java文件
（2）在命令行中執行以下dos命令：
javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔
//javadoc標記：是@開頭的，對javadoc而言，特殊的標記。
（3）在當前目錄下就會產生doc文件夾，裡面有一系列的.html文件
附上代碼：
[java]view plain
<spanstyle="font-size:18px;">*/
/**javadoc注釋的內容
*/
publicclassHello{
/**屬性上的注釋*/
publicStringname;
/**這是main方法,是程序的入口
*@paramargs用戶輸入參數
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**這是第1個方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()！");
}
}</span>
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注釋內容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>鏈接到另一個文檔{@linkHello},就這些
*seeHello
*/
publicclassHelloWorld{
/**非public，protected屬性上的注釋不生成*/
publicStringname;
/**這是main方法，是程序的入口
*@paramargs用戶輸入的參數，是數組
*@throwsIOExceptionmain方法io異常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**這是第一個方法，其作用是....
*@deprecated從版本1.2開始，不再建議使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**這是第二個方法，其作用是....
*@return返回是否OK
*@parami輸入參數i
*@seeHello
*@throwsIOExceptionio異常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
[java]view plain
注意：
如果源文件中有用到@version,@author標記，則在執行javadoc命令時，要加-version-author
javadoc-version-author-ddoc*.java
（其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息）
❻ java代碼如何快速添加作者描述的注釋最好能有詳細的圖解
Window -->Preferences->Java->Editor->Templates ，
在這里new一個自己的插入注釋的快捷方式名稱，具體設置如下：
Name處輸入 remark (任意你喜歡的名稱)
context處選 java 後邊勾選Automatically insert復選框
Description 這里可以任意輸入描述
Pattern :(自定義格式)
/**
* @author ${user}
* @date : ${date} ${time}
*/
到這里全部設置完畢，下面 OK,找個java類,找個空白處測試一下, 輸入remark(前面寫的那個Name名稱),
再alt+/ 應該按一下就能看到剛才的Description的內容。
❼ java中如何自動生成注釋
你說的應該是生成javadoc吧?
最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:
javadoc-ddocs-subpackagescom.yourpackage
其中-d docs指定了生成的javadoc在相對目錄docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代碼包.
JAVADOC是官方提供的一種生成注釋文檔的工具, 他的用法如下:
用法:javadoc[options][packagenames][sourcefiles][@files]
-overview<file>從HTML文件讀取概覽文檔
-public僅顯示public類和成員
-protected顯示protected/public類和成員(默認值)
-package顯示package/protected/public類和成員
-private顯示所有類和成員
-help顯示命令行選項並退出
-doclet<class>通過替代doclet生成輸出
-docletpath<path>指定查找doclet類文件的位置
-sourcepath<pathlist>指定查找源文件的位置
-classpath<pathlist>指定查找用戶類文件的位置
-cp<pathlist>指定查找用戶類文件的位置
-exclude<pkglist>指定要排除的程序包列表
-subpackages<subpkglist>指定要遞歸載入的子程序包
-breakiterator計算帶有BreakIterator的第一個語句
-bootclasspath<pathlist>覆蓋由引導類載入器所載入的
類文件的位置
-source<release>提供與指定發行版的源兼容性
-extdirs<dirlist>覆蓋所安裝擴展的位置
-verbose輸出有關Javadoc正在執行的操作的信息
-locale<name>要使用的區域設置,例如en_US或en_US_WIN
-encoding<name>源文件編碼名稱
-quiet不顯示狀態消息
-J<flag>直接將<flag>傳遞到運行時系統
-X輸出非標准選項的提要
通過標准doclet提供:
-d<directory>輸出文件的目標目錄
-use創建類和程序包用法頁面
-version包含@version段
-author包含@author段
-docfilessubdirs遞歸復制文檔文件子目錄
-splitindex將索引分為每個字母對應一個文件
-windowtitle<text>文檔的瀏覽器窗口標題
-doctitle<html-code>包含概覽頁面的標題
-header<html-code>包含每個頁面的頁眉文本
-footer<html-code>包含每個頁面的頁腳文本
-top<html-code>包含每個頁面的頂部文本
-bottom<html-code>包含每個頁面的底部文本
-link<url>創建指向位於<url>的javadoc輸出的鏈接
-linkoffline<url><url2>利用位於<url2>的程序包列表鏈接至位於<url>的文檔
-excludedocfilessubdir<name1>:..排除具有給定名稱的所有文檔文件子目錄。
-group<name><p1>:<p2>..在概覽頁面中,將指定的程序包分組
-nocomment不生成說明和標記,只生成聲明。
-nodeprecated不包含@deprecated信息
-noqualifier<name1>:<name2>:...輸出中不包括指定限定符的列表。
-nosince不包含@since信息
-notimestamp不包含隱藏時間戳
-nodeprecatedlist不生成已過時的列表
-notree不生成類分層結構
-noindex不生成索引
-nohelp不生成幫助鏈接
-nonavbar不生成導航欄
-serialwarn生成有關@serial標記的警告
-tag<name>:<locations>:<header>指定單個參數定製標記
-taglet要注冊的Taglet的全限定名稱
-tagletpathTaglet的路徑
-charset<charset>用於跨平台查看生成的文檔的字元集。
-helpfile<file>包含幫助鏈接所鏈接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每個製表符占據的空格數
-keywords使程序包,類和成員信息附帶HTML元標記
-stylesheetfile<path>用於更改生成文檔的樣式的文件
-docencoding<name>指定輸出的字元編碼
❽ 什麼是注釋如何在Java程序中加入注釋
試想一下，一個沒有一句注釋的程序源碼，怎麼讀，一個程序要上萬條代碼不可能全部記得住哪一塊是什麼用，而且一個項目也不會是一個人獨自完成，那樣效率太低，多人合作就要給別人說明，每一塊是什麼用，方便他人使用，方便自己更正，而這些說明文字就是注釋，注釋不會被執行，不影響運行結果。
Java中代碼的注釋有三種：
// 注釋一行
/* ...... */ 注釋若干行
/** ...... */ 注釋若干行，並寫入 javadoc 文檔
前兩種比較容易理解，至於第三種，你學習Java看的api文檔就是javadoc程序根據第三種的注釋生成的。
(8)java注釋設置擴展閱讀
注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時，寫程序的人給一個語句、程序段、函數等的解釋或提示，能提高程序代碼的可讀性。
❾ eclipse怎麼設置創建一個java文件後自動加入注釋
eclipse設置創建一個java文件後自動加入注釋的方法：
1、通過菜單 Window->Preference 打開參數設置面板，然後選擇：
Java -> Code Style -> Code Templates
❿ java注釋的自定義
它類似於新創建一個介面類文件，但為了區分，我們需要將它聲明為@interface,如下例：
Java代碼
packagecom.iwtxokhtd.annotation;
public@interfaceNewAnnotation {
}
使用自定義的註解類型
Java代碼
packagecom.iwtxokhtd.annotation;
publicclassAnnotationTest {
@NewAnnotation
publicstaticvoidmain(String[] args) {
}
}
為自定義註解添加變數
Java代碼
packagecom.iwtxokhtd.annotation;
public@interfaceAnnotation {
String value();
}
Java代碼
publicclassAnnotationTest {
@NewAnnotation(main method)
publicstaticvoidmain(String[] args) {
saying();
}
@NewAnnotation(value = say method)
publicstaticvoidsaying() {
}
}
定義一個枚舉類型，然後將參數設置為該枚舉類型，並賦予默認值
public@interfaceGreeting {
publicenum FontColor {
BLUE,RED,GREEN
};
String name();
FontColor fontColor()defaultFontColor.RED;
}
這里有兩種選擇，其實變數也就是在賦予默認值的參數上，我們可以選擇使用該默認值，也可以重新設置一個值來替換默認值
Java代碼
publicclassAnnotationTest {
@NewAnnotation(main method)
publicstaticvoidmain(String[] args) {
saying();
sayHelloWithDefaultFontColor();
sayHelloWithRedFontColor();
}
@NewAnnotation(say method)
publicstaticvoidsaying() {
}
// 此時的fontColor為默認的RED
@Greeting(name = defaultfontcolor)
() {
}
@Greeting(name = notdefault, fontColor = Greeting.FontColor.BLUE)
() {
} 1.1. 限制註解的使用范圍
用@Target指定ElementType屬性
Java代碼(jdk)
packagejava.lang.annotation;
public enum ElementType {
TYPE,
// 用於類，介面，枚舉但不能是註解
FIELD,
// 欄位上，包括枚舉值
METHOD,
// 方法，不包括構造方法
PARAMETER,
// 方法的參數
CONSTRUCTOR,
//構造方法
LOCAL_VARIABLE,
// 本地變數或catch語句
ANNOTATION_TYPE,
// 註解類型(無數據)
PACKAGE
// Java包
}
1.2. 註解保持性策略
Java代碼
//限制註解使用范圍
@Target({ElementType.METHOD,ElementType.CONSTRUCTOR})
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
在Java編譯器編譯時，它會識別在源代碼里添加的註解是否還會保留，這就是RetentionPolicy。下面是Java定義的RetentionPolicy枚舉：
編譯器的處理有三種策略：
將註解保留在編譯後的類文件中，並在第一次載入類時讀取它
將註解保留在編譯後的類文件中，但是在運行時忽略它
按照規定使用註解，但是並不將它保留到編譯後的類文件中
Java代碼
packagejava.lang.annotation;
public enum RetentionPolicy{
SOURCE,
// 此類型會被編譯器丟棄
CLASS,
// 此類型註解會保留在class文件中，但JVM會忽略它
RUNTIME
// 此類型註解會保留在class文件中，JVM會讀取它
}
Java代碼
//讓保持性策略為運行時態，即將註解編碼到class文件中，讓虛擬機讀取
@Retention(RetentionPolicy.RUNTIME)
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.3. 文檔化功能
Java提供的Documented元註解跟Javadoc的作用是差不多的，其實它存在的好處是開發人員可以定製Javadoc不支持的文檔屬性，並在開發中應用。它的使用跟前兩個也是一樣的，簡單代碼示例如下：
Java代碼
//讓它定製文檔化功能
//使用此註解時必須設置RetentionPolicy為RUNTIME
@Documented
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.4. 標注繼承
Java代碼
//讓它允許繼承，可作用到子類
@Inherited
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
2. 讀取註解信息
屬於重點，在系統中用到註解許可權時非常有用，可以精確控制許可權的粒度
注意：要想使用反射去讀取註解，必須將Retention的值選為Runtime
Java代碼
packagecom.iwtxokhtd.annotation;
importjava.lang.annotation.Annotation;
importjava.lang.reflect.Method;
//讀取註解信息
{
publicstaticvoidmain(String[] args)throws Exception {
// 測試AnnotationTest類，得到此類的類對象
Class c = Class.forName(com.iwtxokhtd.annotation.AnnotationTest);
// 獲取該類所有聲明的方法
Method[] methods =c.getDeclaredMethods();
// 聲明註解集合
Annotation[] annotations;
// 遍歷所有的方法得到各方法上面的註解信息
for(Method method : methods) {
// 獲取每個方法上面所聲明的所有註解信息
annotations =method.getDeclaredAnnotations();
// 再遍歷所有的註解，列印其基本信息
System.out.println(method.getName());
for(Annotation an :annotations) {
System.out.println(方法名為： + method.getName()+ 其上面的註解為：
+an.annotationType().getSimpleName());
Method[] meths =an.annotationType().getDeclaredMethods();
// 遍歷每個註解的所有變數
for(Method meth :meths) {
System.out.println(註解的變數名為： + meth.getName 注釋有三種：// /* */ /** */ 前兩種編譯器直接跳過，從來不閱讀，第三種編譯器是可以看懂的，當你使用javadoc這樣的命令時會用到，用來生成API時用的。
註解：這東東完全就是給編譯器看的。 比如@Ovrride表示這個方法是重寫了父類中的方法，而不是自定義的，所以這個時候編譯器會去檢查你的方法名是否和父類一樣，是否寫錯了。
以上是不同的概念
與java注釋設置相關的資料
- php解析xml文檔
- java位元組截取
- php提交作業
- java毫秒轉分鍾
- php自適應網站
- c語言javaphp
- java圖形圖像
- java配置資料庫連接
- java多態的體現
- java的split分隔符
- web和php有什麼區別
- mainjavasrc
- php批量上傳文件夾
- UG編程如何多平面輪廓2D倒角
- php生成靜態html頁面
- java獲取時間gmt時間
- 全自動化編程
- 旅行商問題Python寫法
- ubuntu安裝軟體php
- cnc編程前景怎麼樣
- java網路編程推薦
- 施耐德開關編程
- 編程就是軟體
- 引用指針編程
- java程序升級
- ajax調用java後台
- python操作zookeeper
- python實用工具
- python時間對比
- windows下編譯python
- 編程中計算根號的思維
- plc通訊塊編程
- php注冊框代碼
- 一天一圖學會python可視化
- python類裝飾器參數
- cnc曲面編程實例
- pythonimportcpp
- 華為手機代碼編程教學入門
- javac哪個前景好
- python中的雙色球
- python解釋器里如何換行
- python編寫格式