C#のドキュメント定番は砂の城?

『VSのXMLドキュメントファイル』の続きエントリです :| 結局、VSから吐き出されるXMLファイルだけではどうにもならないことが判明。と言うことで調べてみた。

Javaには、JavaDocという超定番のドキュメント作成の仕組みがある…では、C#にはC#Docとか.NETDocとかはないのか :?:

Google先生に尋ねてみると…以下のようなものが引っかかってきた。

  1. Sandcastle
  2. Ndoc
  3. C#仕様書工房
  4. A HotDocument

ふ~ん、3は富士通製で昔近くの人が使っていた記憶が…ありゃ、もう終焉を迎えつつあるようなので除外。2のNDocもメンテされていないので除外。A HotDocumentも良くわからないが高いので除外 :mrgreen:

と言うことで、やはり選択肢はSandcastle(砂の城)ですか :? あ、個人的にはDoxygen好きなのですが…別の理由から却下されちゃいました :cry:

仕方ないので、Sandcastleを使うべくSandcastle Help File Builderもインストールして出力の日本語化なんてページもあったので参考にしてゴニョゴニョ。

はい。確かになかなか良くできています :) 出力は、MSDNチックな形式でchm形式かHTML形式で行えます。

サンプルを変換した雰囲気は以下のような感じ。

しかし、印刷や変換が意図した通りにできないorz

JavaDocには、Docletという手段が提供されていて色々調整ができますが…SandcastleにはDocletに相当する機能はないのかな :?:

某所のお客さまは、Word文書じゃないとダメなのでなんとか変換しようとガンバッテみたのですが…CHM2WORDとかPDFにしてみたりとか…でも、どうしても望んだ形式にならない :cry:

とチャレンジしていたら…お客さまからの鶴の一声…

リバースはダメだ!ちゃんと、Wordで書け

時代錯誤も良いとこですが…抵抗しようがないですね :cry: まぁ、今後のこともあるのでコメントはちゃんと書いてリバースできるようにはしておくしかないな。

JavaDocのDocletに相当する機能やSandcastleの出力を綺麗にWordかPDFに変換する方法があれば教えてください。

あSandcastleじゃなくても、もちろん構わないです ;)

追記 2008-06-12 15:21:58
なんだか、ソース公開してないのにCodePlexに置くなぁ~という理由で一時的にSandcastleの公開が停止しているとのこと。via. InfoQ: オープンソースの違反により、MicrosoftがSandcastleを削除

追記 2008-06-13 10:40:17
ココで再公開されています。やっぱり、コードまでは出さなかったかぁ~残念 :|

Be Sociable, Share!

TrackBack URL :

Comments

  1. 7月 7th, 2008 | 6:25 PM

    hotdocumentなら、Excelだけどかなり綺麗に出力されますよ。
    http://www.hotdocument.net/gallery/index.html

    確かに高いけど、数万円なら作業工数を考えれば悪くないかもと思います。
    http://www.hotdocument.net/

  2. 7月 8th, 2008 | 12:08 AM

    なんとSandcastleのソースが公開された…

    以前、『C#のドキュメント定番は砂の城?』でも触れましたが、Codeplexに置いてるのにソースが公開されていないと指摘されたSandcastleですが…なんと、ソース公開と共にCodeplexに帰ってき…..

  3. 9月 3rd, 2010 | 5:20 PM

    OX CHM PDF変換は仮プリンタを利用してCHMをPDFファイルに変換するソフトです。作成したPDFファイルはPDF1.2、PDF1.3やPDF1.4をサ ポートしCHMをPDFファイルに変換できて、任意な印刷できるファイルも変換できます。具体的に言えば、Txt、Word、Excel、 Powerpointや画像形式などです。そしてPDFファイルに作成するほかに、「Option]において画像形式(例えばPNG、JPEG、BMP、 PCX、TIFF)や言語編集形式(PS、EPS)などとしても保存できます。
    安全なシステムとしてOX CHM PDF変換 フリーはパスウードをつけることができます。またフリーダウンロードをサポートします。
    http://www.oxpdf.jp/chm-to-pdf-converter.html

Leave a reply