これは、Ubuntu Online、Fedora Online、Windowsオンラインエミュレーター、MACOSオンラインエミュレーターなどの複数の無料オンラインワークステーションのXNUMXつを使用してOnWorks無料ホスティングプロバイダーで実行できるコマンドモノドッカーです。
プログラム：
NAME
monodocer-ECMAドキュメント形式のサポート
SYNOPSIS
モノドカー [オプション]*
OPTIONS
-アセンブリ：アセンブリ
アセンブリ は、ドキュメントスタブを生成するための.NETアセンブリです。
ファイルパスまたはGACされたアセンブリの名前を指定します。
-削除
monodocerがドキュメントファイルからメンバーを削除できるようにします。 唯一のメンバー
削除されたのは、アセンブリ内に存在しなくなったメンバーの場合です。
タイプが存在しなくなった場合、ドキュメントファイルは次のようになります。 削除されましたが、
を取得する必要がある者 名前を変更 〜を持つ 。削除する 拡大。
-?、 -助けて
プログラムの引数情報を表示します。
-無視する
メンバーを更新しないでください。
これにより、追加されたタイプのドキュメントスタブが追加されますが、 追加または削除
任意のタイプ（追加されたタイプを含む）の任意のメンバーのドキュメント。
-importslashdoc：FILE
FILE で生成されたXMLファイルです / doc：FILE C＃コンパイラフラグ（例： mcs
-doc：foo.xml foo.cs ）。 に含まれるメンバードキュメントをインポートします FILE に
monodocで使用されるドキュメント形式。
-name：NAME
NAME このドキュメントの対象となるプロジェクトの名前です。
これにより、 /概要/タイトル 内の要素 インデックス.xml で作成されたファイル
によって指定されたディレクトリ -道 。 これは、タイトル情報のために一部のプログラムで使用されます
（例えば monodocs2html ).
-名前空間：NAMESPACE
名前空間内のタイプのみを更新します 名前空間 .
-オーバーライド
ドキュメントにオーバーライドされたメソッドを含めます。
モノドキュメンテーションブラウザが提供するので、これは通常必要ありません。
とにかく基本タイプのメンバーにリンクします monodocs2html 基本タイプが
同じアセンブリ内。
-パス：OUTPUT_DIR
出力_DIR 新規/更新されたドキュメントスタブを含むディレクトリです。
-可愛い
XMLファイルを適切にインデントします。
-以降：SINCE
作成する値を持つ追加されたタイプとメンバーの要素 以来 .
たとえば、与えられたとき -以降： "Gtk＃ 2.4 " 要素がに挿入されます ドキュメント
追加されたすべてのタイプとタイプメンバーの要素：
モノドキュメンテーションブラウザと monodocs2html この要素を使用して指定します
メンバーが追加されたバージョン。
-type：TYPE
タイプのドキュメントのみを作成/更新します タイプ .
-updateto：PATH
ドキュメントを更新するときは、更新されたドキュメントファイルをに書き込みます
ディレクトリにジョブを開始します。 パス .
-V、 -バージョン
バージョンとライセンス情報を表示します。
DESCRIPTION
モノドカー によって廃止されました mdoc（1）。 を参照してください mdoc-更新（1）マニュアルページ。
モノドカー ECMAドキュメンテーションでXMLドキュメンテーションスタブを作成するプログラムです
フォーマット。 ソースコード内にあるドキュメントには依存しません。
利点は次のとおりです。
* Code 読みやすさ。 優れたドキュメントは、（a）冗長であり、（b）記入されていることがよくあります。
例を挙げて。 （比較のために、Microsoft.NETFrameworkのドキュメントを比較してください。
これは多くの場合、各メンバーのXNUMXページ以上のドキュメントであり、JavaDocドキュメントになります。
多くの場合、これは各メンバーの文章になる可能性があります。）
優れたドキュメントをソースコードに挿入すると、ソースが肥大化することがよくあります
ドキュメントは実際のメソッドよりも長くなる可能性があるため、ファイル
文書化されています。
* ローカリゼーション。 ソース内のドキュメント形式（ / doc ）をサポートしていません
複数の人間の言語。 複数の人間の言語をサポートする必要がある場合
文書化の目的、 モノドカー 各言語がその言語を取得できるので便利です
自分のディレクトリ、および モノドカー 個別のドキュメントごとにタイプ/メンバーを追加できます
ディレクトリにあります。
* 管理。 別のドキュメントと開発があることは珍しいことではありません
チーム。 ドキュメントチームの経験が最小限になる可能性もあります
使用されているプログラミング言語で。 そのような状況では、インライン
ドキュメントチームが誤って挿入する可能性があるため、ドキュメントは望ましくありません
ドキュメントの更新中にソースコードにエラーが発生しました。 または、
ドキュメントチームがセキュリティのためにソースコードにアクセスすることを望まない場合があります
理由。 モノドカー ドキュメントを保持することができます 完全に 分離して
アセンブリの作成に使用されるソースコードとは異なります。
を回すには モノドカー モノによって消費されることができる何かへのドキュメンテーション
ドキュメントブラウザ（デスクトップヘルプブラウザ、またはそのWebインターフェイス）
ドキュメントをパック形式にコンパイルするために必要です。 これは、
たとえば、mdassemblerツールは、次のようにこのツールチェーンを使用できます。
$ monodocer -assembly：MyWidgets -path：generated_docs
$ mdassembler --ecmagenerated_docs -out：MyWidgets
上記により、MyWidgets.zipとMyWidgets.treeが生成され、これらをインストールできます。
システム内。 XNUMXつのファイル（.zipと.tree）に加えて、.sourcesを指定する必要があります
ヘルプシステムのどこにドキュメントを接続する必要があるかを説明するファイルです。
次のような非常に単純なXMLファイル：
上記の構成ファイルは、ドキュメントがECMA形式（
コンパイルされたバージョン）ベースファイル名がMyWidgetsであり、接続する必要があること
ツリーの「classlib-gnome」部分。 定義されたさまざまなノードを確認する場合
ドキュメントでは、通常、にインストールされているmonodoc.xmlファイルを確認できます。
/usr/lib/monodoc/monodoc.xml。
すべてのファイル（.zip、.tree、および.sources）を入手したら、それらをにインストールできます。
次のコマンドを使用するシステム：
$ cp MyWidgets.tree MyWidgets.zip MyWidgets.source `pkg-config monodoc --variable sourcedir`
上記は、Monodocが登録したディレクトリにファイルをコピーします（
これを行うにはroot権限が必要です）。 実際のディレクトリはによって返されます パッケージ構成
呼び出し。
STRING ID FORMAT
文字列IDは、タイプまたはタイプのメンバーを参照するために使用されます。 文字列IDはに文書化されています
ECMA-334第3版、付録E.3.1。 それらは メンバー type 接頭辞 、フルタイプ
名前（名前空間+名前、「。」で区切られます）、場合によってはメンバー名とその他
情報を表示します。
メンバータイププレフィックス：
E: 文字列IDはイベントを参照します。 イベント名はタイプ名の後に続きます。
E：System.AppDomain.AssemblyLoad
F: 文字列IDはフィールドを参照します。 フィールド名はタイプ名の後に続きます。
F：System.Runtime.InteropServices.DllImportAttribute.SetLastError
M: コンストラクターまたはメソッドを指します。 コンストラクターは追加します .ctor タイプ名に、
一方、メソッドはメソッド名を追加します（オプションで
ジェネリックパラメーター）。
コンストラクターまたはメソッドが引数を取る場合、これらはパラメーター内にリストされます
コンストラクター/メソッド名の後：
M：System.Object..ctor , M：System.String..ctor（System.Char []） ,
M：System.String.Concat（System.Object） , M：System.Array.Sort``1（ `` 0 []） ,
M：System.Collections.Generic.List`1..ctor ,
M：System.Collections.Generic.List`1.Add（ `0） .
N: 名前空間を指します。例： N：システム
P: プロパティを参照します。 プロパティがインデクサーであるか、パラメーターを受け取る場合、
パラメータタイプはプロパティ名に追加され、paranthesisで囲まれます。
P：System.String.Length , P：System.String.Chars（System.Int32） .
T: 文字列IDは、ジェネリック型の数が追加された型を参照します。
T：System.String , T：System.Collections.Generic.List`1
さらに興味深いことに、ジェネリック型とメンバーにはXNUMXつの表現があります。
「非バインド」表現（上記の例に示されています）。クラス名の数は次のとおりです。
名前に追加されたジェネリックパラメーター。 に「バインドされた」表現もあります
ジェネリックパラメータのバインディングは「{」および「}」内にリストされています。
アンバウンド： T：System.Collections.Generic.List`1 , T：System.Collections.Generic.Dictionary`2 .
バウンド： T：System.Collections.Generic.List {System.Int32}
T：System.Collections.Generic.Dictionary {System.String、System.Collections.Generic.List {System.Predicate {System.String}}}
.
ご覧のとおり、バインドされたバリアントは任意に複雑にすることができます（ジェネリックスのように）。
さらに、ジェネリックパラメーターが型またはメソッドのジェネリックパラメーターにバインドされている場合、
タイプ/メソッドのジェネリックパラメータの「インデックス」がバインディングとして使用されるため、
クラスFooType{
public static void Foo （System.Predicate 述語）{}
}
このメソッドの文字列IDは次のとおりです。 M：FooType.Foo``1（System.Predicate {`` 0}） 、など 「0 は
にバインドされている0番目のジェネリックパラメータインデックス System.Predicate .
マニュアル FORMAT
モノドカー 説明されているように、Ecmaドキュメント形式と同様のドキュメントを生成します
ECMA-335 3rd Edition、Partition IV、第7章。
ECMA形式との主な違いは、各タイプが独自のファイルを取得することです。
タイプの名前空間と同一のディレクトリ。
ドキュメント内のほとんどの情報は 編集する。 これには、
タイプ名（ / Type / @ FullName ）、実装されたインターフェイス（ /タイプ/インターフェース ）、メンバー
情報 （ / Type / Members / Member / @ MemberName , / Type / Members / Member / MemberSignature ,
/ Type / Members / Member / MemberType , / Type / Members / Member / Parameters など）。
この試験は すべき 変更されるのは、テキストを含むすべての要素です に be 追加された。 、存在する
下 //ドキュメント 要素（例： / Type / Docs , / Type / Members / Member / Docs ）。 内容
ドキュメント 要素は 同一の インラインC＃ドキュメントのセマンティクスと構造
これらの要素で構成されるフォーマット（ECMA-334 3rd Edition、Annex E、セクション2にリストされています）。
以下は、要素の説明内で使用されます。
CREF クラス（またはメンバー）参照を参照し、説明されている形式の文字列です
上記の STRING ID FORMAT のセクションから無料でダウンロードできます。
TEXT 非XMLテキスト、およびXMLはネストしないでください。
XML XML要素のみをネストする必要があります（間接的にテキストを含めることができます）が、
空白テキストは直接の子ノードであってはなりません。
XML_TEXT
自由形式のテキストとXML。他のXML要素をネストできます。
ドキュメントでは、次の要素が使用されています。
<ブロック サブセット="サブセット" type = "TYPE"> XML_TEXT
概念は段落に似ていますが、作成に使用されるテキストのブロックを作成します
テキスト内の分割。 ある程度、 HTMLと同等です
鬼ごっこ。
サブセット 常に値である必要があります なし .
タイプ 使用する見出しとフォーマットを指定します。 認識されるタイプは次のとおりです。
行動 見出しのあるセクションを作成します 操作 .
注意 見出しのあるセクションを作成します 注： .
オーバーライド 見出しのあるセクションを作成します Note 〜へ 継承者 .
使用 見出しのあるセクションを作成します 使用法 .
XML_TEXT
コードのようなフォントでテキストを設定します（HTML要素と同様）。
<code lang="LANGUAGE">テキスト
コードのようなフォントで複数行のテキストを表示する（HTMLと同様）
素子）。 言語 このコードブロックの対象となる言語です。 たとえば、
言語 is C# をタップし、その後、 TEXT 内のC＃言語の構文の強調表示を取得します
モノドキュメンテーションブラウザ。
XML_TEXT
特別に表示する必要のある例を示します。 例えば：
導入段落。
クラスの例{
public static void Main（）
{
System.Console.WriteLine（ "Hello、World！"）;
}
}
<exception cref = "CREF"> XML_TEXT
文書化されたメンバーによってスローされる可能性のある例外を識別します。
は最上位の要素であり、の直下にネストする必要があります
要素。
CREF スローされる例外タイプですが、 XML_TEXT 含まれています
を引き起こす状況 CREF 投げられる。
だった。
XML
アイテムのリストまたはテーブルを作成します。 ネストされたものを利用する XML ,
XML , XML_TEXT ,
XML_TEXT 要素。
リスト 構文は次のとおりです。
箇条書き1
箇条書き2
箇条書き3
テーブル類 構文は次のとおりです。
列1
列2
列3
アイテム1-A
アイテム1-B
アイテム1-C
アイテム2-A
アイテム2-B
アイテム2-C
XML_TEXT
の段落を挿入します XML_TEXT
。 これは、次のような他のタグ内で使用するためのものです , ,
, & （参照してください 、上記）、および他のほとんどの要素。
たとえば、
これはテキストの段落です。
<param name = "NAME"> XML_TEXT
は最上位の要素であり、の直下にネストする必要があります
要素。
パラメータについて説明します NAME 現在のコンストラクター、メソッド、またはプロパティの：
A 番号を含む
処理するウィジェットの数。
<paramref name = "NAME" />
それを示します NAME パラメータです。
これは通常レンダリングします NAME イタリック体のテキストであるため、頻繁に（ab）として使用されます。
HTML要素と同等です。 を参照してください ドキュメント（上記）
例として挙げられる。
<許可 cref = "CREF"> XML_TEXT
現在のメンバーのセキュリティアクセシビリティ要件を文書化します。
は最上位の要素であり、の直下にネストする必要があります
要素。
CREF は必要なセキュリティ許可へのタイプ参照ですが、 XML_TEXT
許可が必要な理由の説明。
ファイルの読み取りと書き込みの許可が必要です。 見る
、
。
XML_TEXT
メンバーに関する詳細情報が含まれています。
は最上位の要素であり、の直下にネストする必要があります
要素。
ここに詳細情報を挿入します。
XML_TEXT
は最上位の要素であり、の直下にネストする必要があります
要素。
メソッドの戻り値について説明します。
A かどうかを指定する
プロセスがアクセスできるかどうか
。
<see cref = "CREF" />
現在のテキスト内に指定されたメンバーへのリンクを作成します。
<seealso cref = "CREF" />
は最上位の要素であり、の直下にネストする必要があります
要素。
エントリを生成できるようにします 見る また 副節。 使用する 指定します
テキスト内からのリンク。
<以来 version = "VERSION" />
は最上位の要素であり、の直下にネストする必要があります
要素。
指定されたタイプまたはメンバーを導入したバージョンの指定を許可します。
説明
は最上位の要素であり、の直下にネストする必要があります
要素。
タイプまたはタイプメンバーに関する（簡単な！）概要を提供します。
これは通常、クラス宣言の一部として表示され、
タイプ/メンバーの適度に短い説明。 使用する 詳細については
情報を表示します。
<typeparam name = "NAME">DESCRPITION
は最上位の要素であり、の直下にネストする必要があります
要素。
これは、ジェネリック型またはジェネリックメソッドの型パラメーターを記述するために使用されます。
NAME タイプパラメータの名前ですが、 DESCRIPTION の説明が含まれています
パラメータ（使用目的、満たす必要のある制限など）。
基になるコレクションのタイプ
他のテキストブロック内で使用するために、単語がタイプパラメータであることを示すために使用されます
（例： ).
もしも構造体であり、...
説明
は最上位の要素であり、の直下にネストする必要があります
要素。
プロパティを記述できるようにします。
A ウィジェット名を含みます。
onworks.netサービスを使用してオンラインでmonodocerを使用する
