Javadoc版本控制

Question

我的項目中有版本號的問題。

說，例如，我有4個班 一個 兩個 三 四

的第一次，我發佈這個軟件，它會被標記爲1.0.0版本

在我的Java文檔發表評論，所有類，我把它作爲 @version 1.0.0

所以現在測試將它發送回來的錯誤類兩個

我更新了第二課，現在必須發佈版本1.0.1

我現在是否在每個課程中更新@version標記？

或者最終我會在javadoc註釋中產生一堆帶有不同版本號的類嗎？

Answer 1

我相信正確的答案只是改變那些受bug影響的文件。

我會離開版本或修訂版本到您的控制版本。在完美的世界中，腳本會保持版本同步。

當然，這個問題是主觀的。如果您打算將版本標籤作爲營銷工具，那麼可以，您可能希望保留所有代碼的相同版本。

Answer 2

我認爲錯誤修復根本不會影響到這一點，因爲在修復錯誤時，您只需更改版本號中的修訂號（第三個）。你不必在你的javadoc中添加一個修訂版本號 - 它在那裏沒用，因爲javadoc被用來描述API，並且API在修復bug時不會改變。

這意味着你應該把只例如@version 1.2，而不是@version 1.2.6

JavaDoc的，只有當你改變你的API變化 - 比你要改變一個重大（1）或次要的（第二）版本號，並應該投影在你的javadoc中。

我認爲你應該只更改已更改的類中的版本號，因爲其他類是從先前版本「繼承」的，因此版本號在沒有改變的類應該保持原樣。但我不確定..