shiba_yu36 https://blog.hatena.ne.jp/shiba_yu36/ $shibayu36->blog; https://blog.shibayu36.org/ 今回はドキュメントの場所をどうやって気づかせるかという話を書く。 ドキュメントがあるときの問題 以前開発のドキュメントをどこに置くか問題 - $shibayu36->blog;に書いたとおり、僕の意見としては 基本は実装に一番近いところにコメントとしてドキュメント書くのが良いと思う いろんなパーツが絡みあうような大きな機能の場合、導入部分だけ別の場所に書く 出来るだけrepository内に入れておくと探しやすく、更新しやすいと思う というものだった。 基本的には一番近いコメントにすると、見つけやすさ・更新しやすさともにある程度担保することが出来る。しかし、メインの部分が明確に決まらない*1い… 190 <iframe src="https://hatenablog-parts.com/embed?url=https%3A%2F%2Fblog.shibayu36.org%2Fentry%2F2014%2F04%2F13%2F095951" title="ドキュメントの場所を知らせるために、落ちるテストを作る - $shibayu36-&gt;blog;" class="embed-card embed-blogcard" scrolling="no" frameborder="0" style="display: block; width: 100%; height: 190px; max-width: 500px; margin: 10px 0px;"></iframe> Hatena Blog https://hatena.blog 2014-04-13 09:59:51 rich https://blog.shibayu36.org/entry/2014/04/13/095951 1.0 100%