2008 年 5 月 28 日
C#のドキュメント定番は砂の城?
『VSのXMLドキュメントファイル』の続きエントリです
結局、VSから吐き出されるXMLファイルだけではどうにもならないことが判明。と言うことで調べてみた。
Javaには、JavaDocという超定番のドキュメント作成の仕組みがある…では、C#にはC#Docとか.NETDocとかはないのか
Google先生に尋ねてみると…以下のようなものが引っかかってきた。
- Sandcastle
- Ndoc
- C#仕様書工房
- A HotDocument
ふ~ん、3は富士通製で昔近くの人が使っていた記憶が…ありゃ、もう終焉を迎えつつあるようなので除外。2のNDocもメンテされていないので除外。A HotDocumentも良くわからないが高いので除外
と言うことで、やはり選択肢はSandcastle(砂の城)ですか
あ、個人的にはDoxygen好きなのですが…別の理由から却下されちゃいました
仕方ないので、Sandcastleを使うべくSandcastle Help File Builderもインストールして出力の日本語化なんてページもあったので参考にしてゴニョゴニョ。
はい。確かになかなか良くできています
出力は、MSDNチックな形式でchm形式かHTML形式で行えます。
サンプルを変換した雰囲気は以下のような感じ。

JavaDocには、Docletという手段が提供されていて色々調整ができますが…SandcastleにはDocletに相当する機能はないのかな
某所のお客さまは、Word文書じゃないとダメなのでなんとか変換しようとガンバッテみたのですが…CHM2WORDとかPDFにしてみたりとか…でも、どうしても望んだ形式にならない
とチャレンジしていたら…お客さまからの鶴の一声…
時代錯誤も良いとこですが…抵抗しようがないですね
まぁ、今後のこともあるのでコメントはちゃんと書いてリバースできるようにはしておくしかないな。
JavaDocのDocletに相当する機能やSandcastleの出力を綺麗にWordかPDFに変換する方法があれば教えてください。
あSandcastleじゃなくても、もちろん構わないです
追記 2008-06-12 15:21:58
なんだか、ソース公開してないのにCodePlexに置くなぁ~という理由で一時的にSandcastleの公開が停止しているとのこと。via. InfoQ: オープンソースの違反により、MicrosoftがSandcastleを削除
追記 2008-06-13 10:40:17
ココで再公開されています。やっぱり、コードまでは出さなかったかぁ~残念
トラックバック URL :
Comments(2)


hotdocumentなら、Excelだけどかなり綺麗に出力されますよ。
http://www.hotdocument.net/gallery/index.html
確かに高いけど、数万円なら作業工数を考えれば悪くないかもと思います。
http://www.hotdocument.net/
なんとSandcastleのソースが公開された…
以前、『C#のドキュメント定番は砂の城?』でも触れましたが、Codeplexに置いてるのにソースが公開されていないと指摘されたSandcastleですが…なんと、ソース公開と共にCodeplexに帰ってき…..