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