ソフトウェア開発メモ

日々のソフトウェア設計、実装で考えている、気づいた事を書いています。それが真実か否かは保証しません。悪しからず。

クラス、パブリックメソッドのコメントを書く基準について調べた。

いろんなOSSを調べた結果です。

・アプリの場合はクラス記述ぐらいしか書かない。使い方の自由度が限定されているので。

・世に公開された汎用的なフレームワークはコメントをきっちり書く。まあ、使い方の自由度が高いし、公開されているメソッドが多い、内部状態は複雑だったりするし、後でドキュメント生成して参照したりするので。

・アプリ内でのみ使用するフレームワークについては場合による。抽象クラス、仕様が複雑かつ様々所 で多く使われるクラスはコメントを書かかれる傾向がある。

コメントを書く書かない基準について、頭の中が整理できたかな。