タグ

2006年2月14日のブックマーク (3件)

  • XML Document(C# によるプログラミング入門)

    概要 ライブラリなどを作成し、公開する場合、ライブラリの内容を他人に理解してもらえるようにドキュメントを作成してやる必要があります。 ところが、プログラムのドキュメントを書く作業というのは結構面倒な作業です。 少しでも面倒な作業を減らせるように、C#コンパイラはC#のソースファイルをコンパイルする際に、一緒にXML形式のドキュメントを作成してくれます。 Javaをご存知の方はJavaのソースからドキュメントを生成するためのツール「javadoc」を使ったことがあるかもしれません。 C#のXML Documentationはこのjavadocと似たようなものです。 javadocとの違いは、コンパイラと別のツールとして提供されているのではなく、C#のXML DocumentationはC#コンパイラ自身に組み込まれていることと、出力形式がHTMLではなく、XMLであることです。 ポイント /

    XML Document(C# によるプログラミング入門)
    mojimojikun
    mojimojikun 2006/02/14
    C# でコメントを書くときにこれを使うとXMLのドキュメントを吐いてくれるらしい
  • @IT:Visual Studio .NETによるチーム開発事始め Visual C# .NETでAPIリファレンスを作る(後編)

    前回はVisual Studio .NET(以下、VS.NET)でのAPIリファレンスの作成方法とその内容について解説した。今回は、APIリファレンスを生成する仕組みである「ドキュメント コメントのタグ」の書き方や、APIリファレンスの応用・関連知識について解説しよう。 1.「ドキュメント コメントのタグ」の概要 Visual Studio .NETでは、プログラムのソース・コードからAPIリファレンスを自動生成することができる。APIリファレンスを生成するために、VS.NETは、ソース・コード内に記述されたXMLタグを元にAPIリファレンス用のコメントを抽出する。このようなXMLタグは「ドキュメント コメントのタグ」と呼ばれている。 ■APIリファレンスとXMLドキュメント・コメント Visual C# .NETには、「ドキュメント コメントのタグ」を使った機能が2つある。1つ目が稿の

  • http://park16.wakwak.com/~mimi/dotnet/top.html