このスレッドはアーカイブ化された過去ログです。
このスレッドはアーカイブ化された過去ログです。
人気のスレッド
難民
386
11176.4
38611176.4既婚女性10008552.8
10008552.8競馬1962700
1962700乃木坂46112662.2
112662.2既婚女性471677.3
471677.3野球ch1711557.7
1711557.7
ニュース速報+3681467.4
3681467.4乃木坂461091408.3
1091408.3乃木坂462101388.7
2101388.7
ニュース速報+3591064.4
3591064.4もっと見る
動作に差し支えのない範囲でコメントを残すことだ。
そこに、次の情報を含める。
・ このファイルの名前
・ このファイルの概要（何をするものかを簡潔に）
・ 最終編集時に施した修正内容
・ 最終編集者（最終編集者以外は書かない）
・ 最終編集日（最終編集日以外は書かない）
■ソースファイルなどの冒頭に記すべきコメントの例
#######################################
#
# プログラムや設定ファイルの名
# そのプログラムの概要
#
# その他のコメント……
# ・このリビジョンで何をしたのか
#
# Written by 最終編集者on 最終編集日
#
#######################################
プログラムの途中にコメントを残すのもよいが、冒頭にも残す。
途中に書いてあるだけでは、書いてある場所を探すのが手間だ。
また、最終編集した際の日付と人（メールアドレスなど）も記す。
長年経った時に、そのリビジョンをいつ誰が作成したのか把握するためだ。それが他人であった場合、
わからないことがあればその者に聞けばいい。だたし、複数人で手を入れていたとして、
最終編集者でない者の名前や日付を残す必要はないし、むしろ消すべきだ。
歴代の担当者が知りたくば、リポジトリーに残っている過去のリビジョンを見れば済む。
同様の理由で、修正前のコードをコメントアウトした状態で残す悪習も止めること。