ある基準ようにphpdocやpythonのdocstring)コメントのC#コードについて教えてください。
質問
が基準条約のようにphpdocやpythonのdocstring)コメントのC#コードでクラスの文書を自動生成ソースコードについて教えてください。
解決
利用できるXML形式のコメント、ツールを使用し引きそれらのコメントへのAPIドキュメント.
この例のコメントのスタイル:
/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)
一部の項目を推進することが目的:
GhostDoc, ある単一のショートカットキーを自動生成するコメントのためのクラスまたは方法です。設, 発生する、MSDNのスタイルドキュメンテーションはXMLコメントです。
他のヒント
/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>
Microsoft用"XMLドキュメンテーションコメント"す"IDEを行頭に付けた説明もできる自動生成MSDN-スタイルの文書を使用ツールなどの設の場合の生成、XMLファイルを出力します。
の世代のXMLファイルのドキュメンタリーを右クリックし[プロジェクトビジュアルスタジオをクリックし、"プロパティ"および"構築することができました。下の方に指定できる場所はXMLコメントの出力ファイルです。
前の答えをXMLの書式です。そう思ってやってきましたスローマの 無料(オープンソース)nDoc援図書館で発生装置 そのすべてのコメントを構文解析します。
C#のみ 書類のコマンド お楽しみに!
私たちの利用をブロックコメントを開く2つ以上の星印はな境界を定文書のコメントです。
/**
Documentation goes here.
(flowerboxes optional)
*/
所属していません StackOverflow