web-dev-qa-db-ja.com

他の人のコードを変更するときにJavadocを変更するにはどうすればよいですか？

私は他の誰かのコードに取り組んでおり、大幅な変更を加えています。 （彼が最初に使用したデータベースとは異なるデータベースを使用するように変換しています。）Javadocコメントで、自分がコードの元の作成者ではないが、私がそれに貢献したことを示すにはどうすればよいですか。これを行うためのクリーンなまたは標準的な方法はすでにありますか？私のグーグルはこれを理解するのに役立ちません。

例：

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

元の作者の名前もわからないので、自分だけが書けます。 。 。

javajavadoc
33
Steph

これらのコメントは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. ダミーの作成者と自分を2番目の作成者として追加します。 @author Unknown@author unascribed（コメントと @ author を参照）。
  4. ライセンスの範囲内で、必要に応じて何でも行います。
34
user166390

複数の@author 鬼ごっこ。したがって、クラスに大幅な変更を加えた場合は、新しい@authorタグに自分の名前を入れます。行った変更をリストする必要はありません-変更履歴はそれを十分に表示するはずです。

11
Chris Jester-Young