- 2008/07/05 15:38
- Python
ドキュメントなんて作ったこと無い。今後も作る気は無かった。
でも、そうも言っていられなくなってきた。。
自分以外の誰かが使うものならば、ドキュメントは作成するべき。
でも、大抵のプログラマはドキュメント作成は苦手なんだろうと思われる。
ruby開発者のまつもと氏ですらも、こう言っている。
ドキュメント
まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。バグも完全に記述されている」と主張しているが、誰も受け入れない。 当り前だ。
名言過ぎる。。。
で、ドキュメントなんですが、まぁ使い方に関しては手書きなりで作成します。
ただソースコードに関してのドキュメントを手書きは厳しい。
まともに開発を行うIT企業だと、詳細設計というものをする時に作るみたいだけど、
そういう規模での開発なんて僕はほとんどしない。
だからなんか自動生成とかしてくれると嬉しい、とか考えている。
pythonにはpydocというモジュールがあるのでそれを使うことにしようと思った。
これはドキュメンテーション文字列という”"”xxx”"”のような形をした文字列を
自動でドキュメントにしてくれるもの、っぽい。
使ったことが無いので詳しくは分からないけど。
まぁできるなら別にそれでもいいんだけど、
Iさんがdoxygenというものを教えてくれた。
なんとなく名前は聞いたことあったけど、Pythonに対応していたとは。
こいつを使って自動でドキュメント作成が可能っぽい。
これはPythonだけじゃなくて、今後使う可能性がありそうないろんな言語でサポートされているので、pydocよりは潰しが利きそうという理由から、これを使ってみることにします。
ドキュメントとかテストとか、正直今まで全部スルーしてたものだから、
今後はなるべく意識的に実行していこうと思ってます。
慣れればきっと、そんなに苦労しなくなるでしょう。
たぶん。
ツール開発って大変だねー。
- Newer: CGムービープログラマー募集
- Older: [python] モジュールの作り方に関して考えた
Comments:0
Trackbacks:0
- Trackback URL for this entry
- http://blog.taikomatsu.com/2008/07/05/python-%e3%83%89%e3%82%ad%e3%83%a5%e3%83%a1%e3%83%b3%e3%83%88%e4%bd%9c%e6%88%90%e3%81%ab%e9%96%a2%e3%81%97%e3%81%a6%e8%aa%bf%e3%81%b9%e3%82%8b/trackback/
- Listed below are links to weblogs that reference
- [python] ドキュメント作成に関して調べる from memlog