コードの作者をどのように追跡しますか？[閉まっている]

これは私が教えられたことがないものです。さまざまな種類のオーサリングスタイルを見てきました。主にJavaとPythonでコーディングします。標準のオーサリングスタイルがあるのか​​、それともすべてがフリースタイルなのかと思っていました。また、あなたが答えた場合、自宅または職場で作成したファイルを作成するために使用するスタイルを添付しても構いません。

私は通常ただ行く

@author garbagecollector
@company garbage inc.

あなたが何を求めているのか完全にはわかりませんが、私は非常に厳格なスタイルを使用しています：

;==========================================
; Title:  Author Style Sample
; Author: Darknite
; Date:   7 Jan 2011
;==========================================

このスタイルは、アセンブリプログラマーから着想を得ています。

これがクラス、テキストファイル、またはSQLストアドプロシージャなどであるかどうかに関係なく、「作成」する必要があるページの先頭にこれを配置します。

なんで？それがバージョン管理システムと「Blame」の仕事です:)

私の会社ではオーサリングは行っていません。代わりに、バージョン管理に処理させます。

チェックインするたびに、ユーザー名が変更リストに添付されます。何かが壊れている場合、誰かが戻って変更履歴を見て、何がいつ、誰が変更したかを確認できます。また、リビジョングラフを適切に調べて、ファイルが時間とともにどのように進化したか、誰が触れたか、どのプロジェクトがそこから分岐したかを確認します。

クラスにauthorタグを配置することで発生する問題は、時間の経過とともに、複数の開発者がそのクラスで作業する可能性が高いことです。更新など。その著者のコメントを更新するための余分なステップであり、余分な小さなステップは多くの場合忘れられがちです。したがって、すぐに古くなってしまいます。

私はそれを全然しません。職場では、ファイルを最後に変更した人の会社名とユーザーIDを使用してファイルに挿入されるテンプレートがあると思いますが、私はそれに注意を払っていません。

一般的に、あなたがそれをどうやってやるかは本当に重要だとは思わない。ファイルにオーサリングスタンプを付ける場合は、一貫したスタイルを選択してそのまま使用します。

JavaDocは、Javaコミュニティの標準です。

http://download.oracle.com/javase/1.3/docs/tooldocs/win32/javadoc.html#@author

@author 名前テキスト

-authorオプションが使用されている場合、生成されたドキュメントに指定されたname-textの「Author」エントリを追加します。docコメントには複数の@authorタグが含まれる場合があります。@authorタグごとに1つの名前を指定することも、タグごとに複数の名前を指定することもできます。前者の場合、Javadocは名前の間にコンマ（、）とスペースを挿入します。後者の場合、テキスト全体が解析されることなく、生成されたドキュメントに単純にコピーされます。したがって、コンマ以外のローカライズされた名前セパレータが必要な場合は、1行に複数の名前を使用します。

それはバージョン管理システムに任せるのが一番だと思います。

GIT の非難機能が気に入っています。コードの各部分/行の作成者を確認できます。単なるファイルではありません。

多くの貢献者がいる大規模なプロジェクトで作業している場合、各ファイルに作成者のリストを注釈してもうまくいきません。ファイルをいくつかの小さなファイルに分割するとき、著者のリストをどうしますか？コードを完全に書き換えた場合、元の著者名を保持しますか？コメントのタイプミスを修正するときに、著者のリストに名前を追加しますか？

これらの質問は、バージョン管理システムに残しておくとよいでしょう。

しかし、著者のリストに完全に反対しているわけではありません。プロジェクト全体の著者のリストを保持することは、完全に理にかなっています。単一ファイルプロジェクトの場合は、そのファイル内に保管してください。大規模なプロジェクトの場合は、READMEまたはトップレベルのソースファイル（別名main.c）に保管してください。しかし、すべてのファイルに著者をリストして繰り返すことは避けてください。

バージョン管理システムを使用するか@author、コードに配置することで追跡します。別の方法として、より一般的に言うと、特定の人々はモジュール全体またはプログラム全体の作者であると言います。これにより、正確にX個の関数またはコード行を担当するマシンの歯車としてではなく、チームの一員として自分自身を考えるようになります。

私はほとんどすべてにDoxygenスタイル（またはKernelDoc）コメントを使用します。私は主にDoxygenが非常に人気のあるCとPHPで働いています。

ほとんどの場合、少なくとも次の情報を含めると役立ちます。

• コピーの許可（または許可なし）/会社または個人の著作権
• 著者名/メール
• 書かれた日付
• 最終更新日

それは、たまたまファイルで作業している人が、自分が持っているもの、それで何ができるか、必要なときに助けを求めることができる人を知るのに役立つはずです。また、彼らが10歳の何かを見ているかどうかも伝えます。

他の人が言ったように、バージョン管理にある追加のドキュメントなので、私は個人的にこれを行いません。しかし、ある種のカンフーコードスニペットを作成する場合、IDEが自動生成できるものなら何でも使用する傾向があります。

たとえば、Delphi 7でこれらの便利なCNToolsをインストールして使用すると、

///a [enter]

そして出てくる

//<author></author>

次に入力します

///d [enter]

そして出てくる

 //<date></date>

サードパーティのユーティリティが対応できるものに相当することを想像しますが、私に関しては、自分自身で作り上げたり破損したりする必要のない標準があります。