java中如何自動生成注釋

你說的應(yīng)該是生成javadoc吧?

創(chuàng)新互聯(lián)專注為客戶提供全方位的互聯(lián)網(wǎng)綜合服務(wù)，包含不限于成都網(wǎng)站設(shè)計、網(wǎng)站建設(shè)、新吳網(wǎng)絡(luò)推廣、微信平臺小程序開發(fā)、新吳網(wǎng)絡(luò)營銷、新吳企業(yè)策劃、新吳品牌公關(guān)、搜索引擎seo、人物專訪、企業(yè)宣傳片、企業(yè)代運營等，從售前售中售后，我們都將竭誠為您服務(wù)，您的肯定，是我們最大的嘉獎；創(chuàng)新互聯(lián)為所有大學(xué)生創(chuàng)業(yè)者提供新吳建站搭建服務(wù)，24小時服務(wù)熱線：028-86922220，官方網(wǎng)址：www.cdcxhl.com

最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:

javadoc?-d?docs?-subpackages?com.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????????覆蓋由引導(dǎo)類加載器所加載的

類文件的位置

-source?release????????????????提供與指定發(fā)行版的源兼容性

-extdirs?dirlist???????????????覆蓋所安裝擴展的位置

-verbose?????????????????????????輸出有關(guān)?Javadoc?正在執(zhí)行的操作的信息

-locale?name???????????????????要使用的區(qū)域設(shè)置,?例如?en_US?或?en_US_WIN

-encoding?name?????????????????源文件編碼名稱

-quiet???????????????????????????不顯示狀態(tài)消息

-Jflag?????????????????????????直接將?flag?傳遞到運行時系統(tǒng)

-X???????????????????????????????輸出非標準選項的提要

通過標準?doclet?提供:

-d?directory???????????????????輸出文件的目標目錄

-use?????????????????????????????創(chuàng)建類和程序包用法頁面

-version?????????????????????????包含?@version?段

-author??????????????????????????包含?@author?段

-docfilessubdirs?????????????????遞歸復(fù)制文檔文件子目錄

-splitindex??????????????????????將索引分為每個字母對應(yīng)一個文件

-windowtitle?text??????????????文檔的瀏覽器窗口標題

-doctitle?html-code????????????包含概覽頁面的標題

-header?html-code??????????????包含每個頁面的頁眉文本

-footer?html-code??????????????包含每個頁面的頁腳文本

-top????html-code??????????????包含每個頁面的頂部文本

-bottom?html-code??????????????包含每個頁面的底部文本

-link?url??????????????????????創(chuàng)建指向位于?url?的?javadoc?輸出的鏈接

-linkoffline?url?url2????????利用位于?url2?的程序包列表鏈接至位于?url?的文檔

-excludedocfilessubdir?name1:..?排除具有給定名稱的所有文檔文件子目錄。

-group?name?p1:p2..????????在概覽頁面中,?將指定的程序包分組

-nocomment???????????????????????不生成說明和標記,?只生成聲明。

-nodeprecated????????????????????不包含?@deprecated?信息

-noqualifier?name1:name2:...?輸出中不包括指定限定符的列表。

-nosince?????????????????????????不包含?@since?信息

-notimestamp?????????????????????不包含隱藏時間戳

-nodeprecatedlist????????????????不生成已過時的列表

-notree??????????????????????????不生成類分層結(jié)構(gòu)

-noindex?????????????????????????不生成索引

-nohelp??????????????????????????不生成幫助鏈接

-nonavbar????????????????????????不生成導(dǎo)航欄

-serialwarn??????????????????????生成有關(guān)?@serial?標記的警告

-tag?name:locations:header?指定單個參數(shù)定制標記

-taglet??????????????????????????要注冊的?Taglet?的全限定名稱

-tagletpath??????????????????????Taglet?的路徑

-charset?charset???????????????用于跨平臺查看生成的文檔的字符集。

-helpfile?file?????????????????包含幫助鏈接所鏈接到的文件

-linksource??????????????????????以?HTML?格式生成源文件

-sourcetab?tab?length??????????指定源中每個制表符占據(jù)的空格數(shù)

-keywords????????????????????????使程序包,?類和成員信息附帶?HTML?元標記

-stylesheetfile?path???????????用于更改生成文檔的樣式的文件

-docencoding?name??????????????指定輸出的字符編碼

eclipse怎么生成注釋文檔

/步驟

先看默認狀態(tài)的吧，新建類文件時，是不生成注釋的

在

windows--preferenceJava--Code Style--Code Templatescode--new Java file

編輯文件為7的樣式，（為了方便起見，中間分布截圖說明，熟悉的朋友直接跳到7）

對于中文版本

窗口--首選項

java--代碼樣式--代碼模板

代碼--新的java文件

菜單欄，窗口——首選項

找到j(luò)ava選項--代碼樣式

注釋--新生成的java文件

直接編輯配置文件

在配置文件中間添加注釋代碼，這部分可以自定義，參考如下，關(guān)鍵字解釋見后文10

${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 創(chuàng)建時間：${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}

現(xiàn)在新建文件將自動生成注釋

eclipse怎么設(shè)置創(chuàng)建一個java文件后自動加入注釋

eclipse設(shè)置創(chuàng)建一個java文件后自動加入注釋的方法：

1、通過菜單 Window-Preference 打開參數(shù)設(shè)置面板，然后選擇：

Java - Code Style - Code ?Templates

2、在右側(cè)選擇Comments,將其中的Files項，然后選右邊的"Edit"，進入編輯模式： ??

3、進入編輯模式后就可以自定義注釋了。另外可以插入一些變量，如年、日期等等。

4、最后，確保 Code - New Java files 中有："${filecomment}"

java 怎樣給源代碼添加注釋

1、單行(single-line)--短注釋：//…… 單獨行注釋：在代碼中單起一行注釋， 注釋前最好有一行空行，并與其后的代碼具有一樣的縮進層級。如果單行無法完成，則應(yīng)采用塊注釋。 注釋格式：/* 注釋內(nèi)容 */ 行頭注釋：在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式：// 注釋內(nèi)容 行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進行注釋。一般與代碼行后空8（至少4）個格，所有注釋必須對齊。 注釋格式：代碼 + 8（至少4）個空格 + // 注釋內(nèi)容 2、塊(block)--塊注釋：/*……*/ 注釋若干行，通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說明，或者算法的描述。一般位于一個文件或者一個方法的前面，起到引導(dǎo)的作用，也可以根據(jù)需要放在合適的位置。這種域注釋不會出現(xiàn)在HTML報告中。注釋格式通常寫成： /* * 注釋內(nèi)容 */ 3、文檔注釋：/**……*/ 注釋若干行，并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符 /**......*/ ...

如何寫好java代碼注釋

寫代碼的時候，有時候，你需要寫一些注釋，把內(nèi)容相互關(guān)聯(lián)起來，方便自己或別人看的時候，可以直接找到你關(guān)聯(lián)的代碼類或者啥的。

這個時候，{@link}與@see，這2個javadoc注解就派上用場了，

不管他具體有什么功能，咱就只管一個，他可以鏈接代碼，讓注釋看的更清楚易懂。方便你我他。

@see 標簽允許用戶引用其他類的文檔。具體使用方式如下：

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名稱

@see fully-qualified-classname#屬性名稱

我在使用的時候，發(fā)現(xiàn)這個只能單獨一行頂頭寫，如果不頂頭寫就不管用了，沒了鏈接的效果。

但是，{@link}這個卻可以隨便放。

具體使用方法和上面那個@see是一樣的。

實際效果，看下面的圖

java代碼注釋所有代碼

import?dao.CourseDao;

import?java.io.IOException;

import?java.io.PrintWriter;

import?javax.servlet.ServletException;

import?javax.servlet.http.HttpServlet;

import?javax.servlet.http.HttpServletRequest;

import?javax.servlet.http.HttpServletResponse;//以上?import?為導(dǎo)入的包

public?class?CourseServlet?extends?HttpServlet?{//CourseServlet?繼承HttpServlet

/**

?*?doGet方法，處理GET請求

?*/

public?void?doGet(HttpServletRequest?request,?HttpServletResponse?response)

throws?ServletException,?IOException?{

doPost(request,?response);

}

/**

?*?doPost方法，處理POST請求

?*/

public?void?doPost(HttpServletRequest?request,?HttpServletResponse?response)

throws?ServletException,?IOException?{

response.setContentType("text/html");//設(shè)置內(nèi)容類型為“text/html”

PrintWriter?out?=?response.getWriter();//獲取輸出流

String?opttype?=?request.getParameter("opttype");//讀取參數(shù)"opttype"

String?c_no?=?request.getParameter("c_no");//讀取參數(shù)"c_no"

if?("queryAll".equals(opttype))?{//判斷操作類型

request.getSession().setAttribute("cuslist",

CourseDao.queryallCourse());//綁定參數(shù)"cuslist"

response.sendRedirect("admin_pages/course.jsp");//頁面跳轉(zhuǎn)到"admin_pages/course.jsp"

}

if?("query".equals(opttype))?{//判斷操作類型

request.getSession().setAttribute("cuslist",

CourseDao.queryallCourse(c_no));//綁定參數(shù)"cuslist"

response.sendRedirect("admin_pages/course.jsp");//頁面跳轉(zhuǎn)到"admin_pages/course.jsp"

}

if?("update".equals(opttype))?{//判斷操作類型

request.getSession().setAttribute("c_no",?c_no);//綁定參數(shù)"cuslist"

request.getSession().setAttribute("cuslist",

CourseDao.queryallCourse());//綁定參數(shù)"cuslist"

response.sendRedirect("admin_pages/course.jsp");//頁面跳轉(zhuǎn)到"admin_pages/course.jsp"

}

if?("update1".equals(opttype))?{//判斷操作類型

String?c_time=request.getParameter("c_timexiugai");

CourseDao.updateList(c_no,?c_time);//綁定參數(shù)"cuslist"

request.getSession().setAttribute("cuslist",

CourseDao.queryallCourse());//綁定參數(shù)"cuslist"

response.sendRedirect("admin_pages/course.jsp");//頁面跳轉(zhuǎn)到"admin_pages/course.jsp"

}

if?("delete".equals(opttype))?{//判斷操作類型

CourseDao.deletelist(c_no);

request.getSession().setAttribute("cuslist",//綁定參數(shù)"cuslist"

CourseDao.queryallCourse(c_no));//綁定參數(shù)"cuslist"

response.sendRedirect("admin_pages/course.jsp");//頁面跳轉(zhuǎn)到"admin_pages/course.jsp"

}

out.close();//關(guān)閉輸出流

}

}