SHFB

昨日もつまらないことでつまりましたが,今日も躓きました.

C言語で書いたメソッドのインターフェイスや処理内容を仕様書にまとめるにあたり,保守性を上げるため,ソースコードにXMLコメントの形で書くことにしました.ま,常套手段でしょう.それをCHM形式にするため,Sandcastle Help File Builderをインストールし,実行しました.しかし,正しく出力されません.summaryタグなどがmissingになります.

なしてか.XMLにはsummaryタグとかちゃんと出力されています.スペル間違いもなさそう.C言語はC#と違い,Visual Studioのエディタで「///」と打っても「/// <summary>」と補完されないので,微妙に非対応な感じもしますが,ちゃんとXMLを作るビルドオプションもあるし,ちゃんとCHM形式にできていました.会社のデスクトップPCに入っているSHFBとバージョンが違うけど,それが原因なのか? うーむ.この手の調査,相変わらず苦手で時間かかっちゃうのよね.

ようやく原因判明.ネイティブなC言語ではSHFBがうまく動かないみたい.試しにマネージな感じに,具体的にはC++/CLIのクラスライブラリにしてみたら,ちゃんと行けました.もしかしたら過去に試して成功したときも,C++/CLIだったのかも.

だとして,CHM形式のファイルを作るためだけに,本番のネイティブCとは別のダミーC++/CLIプロジェクトへわざわざコピペする運用,どうなの? 折角XMLコメントちゃんと書いたので,とりあえず今回はこれで押して参りますが.

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です