1

PHPDocを使用して関数の変更を文書化するための最良の方法は何ですか？何かのようなもの

@change 2010.20.16  user  added feature x
@change 2010.20.26  user  added feature y

素晴らしいことだ。しかし、@changeオプションがないと仮定します...とにかくそれを追加した場合、PHPDocはそれをどのように処理しますか？または、機能の変更を文書化するためのより良い/より正しい方法はありますか？

4

1 に答える 1

3

SCMログをchangelogtxtファイルにダンプしてから、ソースコードに埋め込んだほうがよい場合があります。

理由：

  1. 陳腐化-コーディングマラソン/運命のスプリントに参加しなければならない場合に発生する可能性のある変更メモの追加を停止すると、誰も役に立たなくなります。

  2. 型破りな-インラインドキュメントの詳細なプロジェクトを見たのを覚えていません。慣習がばかげていることもありますが、この慣習の知恵はメンテナンスを削減していると思います。

于 2010-04-17T17:07:15.487 に答える