ソース管理を使用していないいくつかの場所で働いています。彼らは、変更を説明したコードの周りにコメントを入れるという習慣に乗っているように見えました。ファイル内の変更履歴
これは、コードを読みにくくすることが判明しました。改訂履歴でチケットを変更に合わせることができるように、ソース管理を導入した後にそのようなコメントが不要であることはかなり確信しています。
しかし、私は確信が持てません。ファイル内のファイルとコミットメッセージのメジャーリビジョンを文書化するとよいかもしれません。これは、コードをより読みやすくするはずです。コードの変更を文書化するベストプラクティスの方法はありますか。あまりに複雑すぎるのではなく、それを読もうとしている人にはまだ説明が残っていますか?
ファイルの先頭の変更点のリスト(他のすべての引数です)ではなく、コード内のコメントについて説明しています。
私は考える必要はない、私はそれを見て、それは恐ろしいです –