【ハウツー】SandcastleでXMLドキュメントコメントからヘルプを生成する - HTML生成編 (1) XMLドキュメントコメントの書き方 | エンタープライズ | マイコミジャーナル
ヘルプドキュメントの作成 チームで開発をしている時に、共通部品のドキュメントがあれば良いのにと思ったことはありませんか。また、MSDNのようなAPIリファレンスを作成しなければいけない状況になったことはありませんか。 このような時にWordやExcelを使ってヘルプドキュメントを書くとなると、プログラムとの整合性を保つ必要があり多くの工数がかかります。そこで本稿では、ソースコードに記述したクラスやメンバの説明から、リファレンス形式のヘルプドキュメントを生成できる「Sandcastle(サンドキャッスル)」というツールについて紹介します。 構成について 本稿では、Sandcastleというソフトウェアを使って、.NETのソースコードに記述したコメントからヘルプファイルを生成する方法について紹介します。この前編では、以下の内容について紹介します。 ・Sandcastleの概要とXMLドキュメン
＠IT：Visual Studio .NETによるチーム開発事始め Visual C# .NETでAPIリファレンスを作る（前編）
あなたのチームでは、クラスやメソッドの知識を共有できているだろうか。 チーム開発では、プログラムのソース・ファイルを共有するのが一般的だ。その場合、どこに何のクラス、メソッド、プロパティがあるのかを、チーム内のメンバー全員が正確に把握できるようにして、知識を共有する必要がある。知識の共有が十分でないと、開発時にクラスやそのメンバの使用方法、機能を調べるなどの余分な「時間と労力のコスト」がかかってしまうからだ。また、余計な時間がかかるだけでなく、同じ機能を持つクラスやメソッドを複数作ったり、使い方を間違えたりといった「トラブルが発生する可能性」が高くなってしまう。 1．APIリファレンスのすすめ チームでクラスやメソッドの知識を共有するには、クラスやメソッドのリファレンス・マニュアル（以下、APIリファレンス）を作成することが欠かせない。APIリファレンスがあれば、チーム内の全員がクラスやメ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
