Edited at

コード読みたくないので全てのクラスに日本語3行で概要を付けて欲しい

More than 1 year has passed since last update.

全てのクラスに日本語3行で概要を付けて欲しいと最近よく思う。

*Docに則ってればなおいいですが、それほど細かくなくても、概要があるだけでも十分だと思います。

これがない状態で全貌を知ろうとすると、無駄にソースコード読むことになるし、そこに手を加えるとき、どうなってるのが設計的に正しいのかわからないから。

そもそもそこに課題意識は皆ないのだろうか。

自分はとにかく楽したくて、てっとり早く内容が知りたい。

100%まで知らなくていい、60%くらいつかめればいい。

けど大体の場所でそういう提案をすると、

読めばわかるじゃん

聞けばわかるじゃん

に跳ね返されてしまう。

皆そんなもんなんだろうか。

PHPだとdoc書いてる人が多いように感じる。(自分もPHPだと書く)

最低限書いておきたいPHPのDocコメント

http://qiita.com/motoyan-qwt/items/ee973666f1105435822c

ちなみに筆者は


  • iOSアプリエンジニア

  • ドキュメントはメンテされてない

  • コードにコメント少ない

  • 同時並行で10くらい案件動いてる

という環境で働いています