ドキュメントの場所を知らせるために、落ちるテストを作る - $shibayu36->blog;

今回はドキュメントの場所をどうやって気づかせるかという話を書く。 ドキュメントがあるときの問題 以前開発のドキュメントをどこに置くか問題 - $shibayu36->blog;に書いたとおり、僕の意見としては 基本は実装に一番近いところにコメントとしてドキュメント書くのが良いと思う いろんなパーツが絡みあうような大きな機能の場合、導入部分だけ別の場所に書く 出来るだけrepository内に入れておくと探しやすく、更新しやすいと思う というものだった。 基本的には一番近いコメントにすると、見つけやすさ・更新しやすさともにある程度担保することが出来る。しかし、メインの部分が明確に決まらない*1いろんなパーツが関係しあう機能の場合は、ドキュメントを書かないと全体の概要が分からないということもある。このような時、ドキュメントを書いても結局そのドキュメントに気づかれないし、そのため更新されないとい

[shiba_yu36]

書いたけどいまいちわかりやすくならなかった

[hisaichi5518]

あるスクリプトが実行されるべきなのに実行されていなかったらテストをfailさせて、ほげほげを実行しよう！！みたいなの表示するっていうのやってる。

[sona-zip]

これほんと大事だと思う 探さないと見つからないドキュメントはよくない 使っていて何か困ったときに自然にドキュメントが目にはいるのが理想

[ryonext]

設定ファイル書き換えて動かなくなる事案確かに多いのでこれは有用だわ

[hiromark]

なるほろ

[poppun1940]

2014-04-13 ドキュメントの場所を知らせるために、落ちるテストを作る 今回はドキュメントの場所をどうやって気づかせるかという話を書く。 ドキュメントがあるときの問題 以前開発のドキュメントをどこに置くか問題 - $sh

[kimikimi714]

なるほど。いくつかのクラスで思い当たるものがある。全部はさすがに無理だけど、気付いたものからやってみようかな。

[ryopeko]

コメントに書いてあったりするけど、仕組みとして組み込んじゃうのはありかもな