オレオレ・コーディング規約 : コメント方針２

処理ブロックごとに何をしているのか概要を入れる。

一行ごとにコメントは入れるようなことをせず、わかりやすいコーディングを心がける。1行に対するコメントが必要な状況に至った場合、わかりやすくなるようにコード自体を書き換える、又は関数のインターフェースの再設計を考える。

コード実行時想定する状況を、関数の場合@preに書く、関数内コードの場合

// 'renderingoptions' parse finished ...

...を最後に書くような形でブロック説明と区別する。