當我修改別人的代碼時，如何修改Javadoc？

Question

我正在研究別人的代碼並進行重大修改。 （我將它轉換為使用與他最初使用的數據庫不同的數據庫。）我如何在Javadoc注釋中指出我不是代碼的原始作者，但我確實為它做出了貢獻。 有沒有干凈或標准的方式這樣做？ 我的谷歌搜索並沒有幫助我解決這個問題。

例：

/**
* This class does some really awesome stuff.
* 
* @author Steph the Great - Modified to use PostgreSQL instead of Derby;
*         added comments to the code
*/

我也不知道原作者的名字，所以我能說的就是我自己。 。 。

Answer 1

這些評論不屬於javadoc :-) javadoc應該解釋合同 - 它是在自動生成的“文檔”中提取和顯示的內容。 其余的只是正常的評論，或者在這種情況下，SCM日志條目可能更好，並且在javadoc中沒有位置！

我可能會離開原作者，但如果你想要信用......

...請參閱@author javadoc參考，並注意它可以多次包含。 本節明確涉及多位作者和訂購等。

/**
* This class does some really awesome stuff.
* It uses PostreSQL. 
*
* @author Steph the Great
* @author Freddy Four Fingers
*/
// DEC2012 - Fred - Modified to use PostgreSQL instead of Derby (but really, use SCM!)
class Awesome { ... }

快樂的編碼。

---

關於問題的注釋與帖子中的例子有些無關......如果作者不為人所知，那么可以做幾件事。 首先，最重要的是添加一個鏈接或引用到原始源的獲取位置 - 一個可選的“我最初沒有寫這個”，為了清楚起見也可以注意到。

然后，根據您的偏好：

1. 不要指定 @author字段 - 甚至不指定自己。 這不是必需的。
2. 將自己添加為唯一作者; 上面在javadoc中提到了原始源代碼
3. 添加一個虛擬作者和你自己作為第二作者，例如 @author Unknown @author unascribed （參見評論和@author ）。
4. 如果有的話，在許可條款中做任何你想做的事。

Answer 2

您可以擁有多個@author標記。 因此，如果您對某個類進行了大量更改，只需在其中添加一個帶有您自己名稱的新@author標記。 沒有必要列出你所做的改變 - 修訂歷史應該足夠好。