5.6 DRYなドキュメント

vimスクリプト書いててよかったと思うのは、
ドキュメントを書く習慣が身に付けられたことです。
といってもまぁこれもvimスクリプトの構造的なおかげじゃなくて、
doc/plugin-name.txt とか doc/plugin-name.jax を書くべきである
という習慣のためなんですけど。


あと「UNIXという考え方」にある通り、

  1. だいたいの仕様を決める
  2. コード書く
  3. 1と2を納得のいくまで繰り返す*1
  4. 満足の行くものを作れたらドキュメント書く
  5. その後はAPIが変わるたびにちまちまドキュメントを変更していく

みたいなサイクルで開発していけばドキュメントは質の高いものが作られるはず。
自分のvimスクリプトのdoc/以下を見てもらうとわかると思います。
まぁ書いてないのもたまにあったりしますが...(えぇー...)


まぁ、タイトルの「DRYな」ドキュメント生成は自分は使ったことないです。
doxygenとかちょこっと使った気もするけど、
ぶっちゃけソースコードとドキュメントを一緒くたにするとみづらくありませんか。
PerlのPODなんかは違う場所にまとまってるから見やすいものの。

これはGaucheのshiroさんもどっかで言ってました。
しかしうろ覚えなのであてにしないでください...
思い付きで引き合いにだしてすみません...


まぁPerlとかVimスクリプトとか
ドキュメントを重視する言語から始められたことは
ほんとによかったと思ってます。

*1:とにかく「動くもの」を見て試行錯誤する