NetBeans - 在代碼更改時自動將@author添加到類中

如何讓NetBeans 8.1+自動將@author標記添加到我編輯的類的JavaDoc中？NetBeans - 在代碼更改時自動將@author添加到類中

2016-11-21 Ondra Žižka

最近有這個過程，Netbeans的自動化是運行Tools -> Analyze Javadoc之前提交到庫，並勾選所有藍色（修改）和綠色失蹤的javadoc一類（新）項。但是，如果某個類的註釋已存在，則該過程不會添加@author標記，也不會更新現有標記。這裏是the manual。

我不確定自動標記每個被觸摸的人創建的每個文件的用處，但是，這可能是此功能無法使用的原因。改變1％的課程是否值得作者改變？什麼約40％？如何重新洗牌進口？等等......我想可以想出一個替代解決方案，例如引入@lasteditor或多個@author或@editor標籤，但我仍然不相信這會增加很多價值。

git blame（Team -> Show Annotations），git log等似乎更適合追蹤作者和編輯的任務。

一個替代解決方案，至少在Maven項目，可能是Javadoc plugin的javadoc:fix目標，但它只能確保每個類的javadoc中有@author標籤，並沒有什麼花哨超出了：

<plugin> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <groupId>org.apache.maven.plugins</groupId> 
    <version>2.10.3</version> 
    <configuration> 
     <fixTags>author</fixTags> 
     <force>true</force> 
     <fixFieldComment>false</fixFieldComment> 
     <fixMethodComment>false</fixMethodComment> 
    </configuration> 
</plugin>

來源

2016-11-27 22:54:11

廣告效用 - 這基本上取決於團隊的想法。並非所有的代碼總是被SCM覆蓋。在文件中添加作者對於未來的編輯者是有好處的，因爲之前很可能研究過該文件，並且可能會詢問有關詳細信息。這不是關於「聲稱」作者身份，真的。這可能是你的假設。 –

我只是指出Netbeans開發人員在考慮此功能時可能會考慮什麼，該工具如何確定變更足夠重要以保證@ @ author'標籤更新，還是應該關心它在這種情況下，比如簡單的輸入錯誤修正會導致更新。在某些情況下，我認爲在描述一個單獨的自述文件或changlog文檔時，給出更多的上下文會比創作使用'@ author'標籤更好，但正如您所說，這是由團隊決定的。 –

NetBeans - 在代碼更改時自動將@author添加到類中

回答

相關問題