ソースコード改造の発注時に気をつけること

java

メモメモ。他にあれば、ぜひおしえてください。

  • ソースコード中の改変コメント（"// add 2011.02.03 katzchang start"等）は不要です。
  • 元のソースコードのコメントアウトは不要です。必要ないコードはそのまま削除してください。
  • ifなどのブロック（"{ ... }"）の追加や削除の場合、ブロック中のソースコードに改変がないとしても、インデントを適切に増減させてください。
  • Javadoc コメントを記述する場合、定義と矛盾がないようにしてください。メソッドコメントの @param が特に矛盾しやすいようです。setter/getterのように自明であれば、省略しても結構です。
  • Javadoc以外で、ブロックコメント("/* ... */")は使わないでください。

SCMで適切に管理されていることが前提です。

追記

あぁ、大事なことを忘れていた。

  • VSSで管理しないでください。改行コードが崩れています。

VSSのせいかどうかわかんないけど、そういう現象ってありませんか？