cafegale(LeafCage備忘録)

LeafCage備忘録(はてなダイアリー)と統一しました。

コードコメントのルールについて

コードコメント種別接頭辞0.0.1

  • (空白文字)or(空文字)]
    • Description.Explanation.実装の説明、解説
  • u] c]
    • Unmounted Conception(構想) 未実装部品(これから実装する
  • i] a]
    • Incomplete Along 未完成部品
  • ds]
    • Dissatisfied.一応完成したが不満点あり
  • t]
    • Temporary.スタブとか。正式な仕様にはしないもの。ds]と意味は似ているが、こちらは作る前から分かっているときに使う
  • f]
    • Finished.Completed.Closed.完了したタスク。タスクマネージャとして使っているコメントにのみ適用。そうでなければ(空文字)]を使う

前置コメントと後置コメントについて

  • 特にややこしい場合、前置コメントには>>、後置コメントには<<を接頭する
    • 全体的(セクション・ブロックを指し示す)な注釈は>、
    • 部分的な注釈は>>、<<