Sandcastle Help File Builder を使って、ソースコードからドキュメントを自動作成しよう
Sandcastle というのは、ソースコードの構造やコメントを元に、ドキュメント(APIや内部説明書)を自動作成してくれるソフトです。 類似のソフトとして、doxygenやNDocがあります。 今回は、Sandcastle と 支援ソフトの Sandcastle Help File Builder の使い方について、簡単に説明します。 まずは概要 Sandcastleには、以下の特徴があります。 MSDN風のHTML Help形式(.chm)のドキュメントを作成してくれます。 .NET 2.0に対応しています。 Microsoft自身が対応してくれています。 VS SDK 4.0 December CTP に同梱されたり、単独で配布しています。 日本語を使っても大丈夫のようです。 Sandcastleについて、先行で調べてらっしゃる方については、以下が参考になると思います。 Kazzzの
SourceForge.net: sakura-editor » DoxygenComment
home 開発に参加したい方へ 仕様検討 内部構造 外部リンク HotTopics └ トリプルクリックDoxygenComment開発に参加したい方へ＞doxygen＞コメントの書き方 Table of Contentsコメントの書き方(クラス・関数のコメント) doxygenで認識されるコメント スタイル コメントの位置 Doxygenへの指示 コマンド 自動的なリンクの作成 具体的なコメントの書き方 ファイル クラス 関数 変数 コメントの書き方(クラス・関数のコメント) ソースコード中のコメントをdoxygenの解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありませんので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
