Java版权信息之Jautodoc
Java項目開發(fā)中,常常需要在編碼文件上面加上一些版權聲明或者類注釋,如果文件很多,手工去添加或者修改,會很麻煩。可以利用工具滿足我們的要求。
一、版權聲明
可以使用Jautodoc。將jautodoc的plugin和feature目錄對應copy到eclipse目錄中,并且?guī)?clean參數(shù)重新啟動一次eclipse(以后不再需要該參數(shù))。到eclipse的window->preference菜單中,java- jautodoc,configure project specific settings中,選擇add file header,并點【edit】按鈕,輸入版權信息,保存。
以后要添加版權時,按alt+shift+J,就可以了。
類似的版權信息如下:
/**
*@項目名稱: ${project_name}
*@文件名稱: ${file_name}
*@Date: ${date}
*@Copyright: ${year}www.xxx.comInc. All rights reserved.
*注意:本內(nèi)容僅限于xxx公司內(nèi)部傳閱,禁止外泄以及用于其他的商業(yè)目的
*/
其中${project_name},${file_name}和${date}、${year} 是內(nèi)置的變量,在編輯模板的時候,輸入$之后,會有很多類似的變量提示顯示出來。
二、類注釋,方法注釋等
可以直接使用eclipse的code style功能。
類注釋在window-reference-java-code style-code templates-comments,選中types,然后點擊【edit】按鈕,輸入類注釋信息,保存。
以后要添加版權時,按Ctrl+alt+J(快捷方式可以在Window-preference-general-keys查看和修改),就可以了。
類似的類注釋如下:
/**
*@Project: ${project_name}
*@Author: Vin
*@Date: ${date}
*@Copyright: ${year}www.xxx.comInc. All rights reserved.
*/
同樣,這里的${date}也是預定義的變量 。
window-preference-java-code style-code templates-comments,選中types,可以編輯類的注釋,
window-preference-java-code style-code templates-comments,選中files,可編輯類文件的注釋
window-preference-java-code style-code templates-comments,選中methods,可編輯方法的注釋
等等。
在window-preference-java-code style-code templates-code,編輯new class files,加入
${filecomment}
${package_declaration}
${typecomment}
${type_declaration}
可以在新建一個類文件的時候自動加入前面設置的文件注釋和類注釋。
方法注釋的操作與類注釋的操作類似。可以自己研究。
最后,要使用這些注釋,在window-preference-java-code style,將Automatically add comments for new methods and types選上才可應用到開發(fā)中。或者將光標放在需要加注釋的方法或類里按Alt+Shift+J鍵
總結
以上是生活随笔為你收集整理的Java版权信息之Jautodoc的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 为什么需要架构图,怎么画?
- 下一篇: Php 与 Json