Visual Studio の機能である XML ドキュメント コメントを .NET COBOL コードで使用できます。XML コメントを使用すると、ネームスペース、型、およびメンバーの定義をコードに含めることができます。これらの定義は次のように使用されます。
コードのドキュメント コメントを含む XML ファイルを生成するには、次の手順を実行します。
XML ドキュメント コメントの各行は、「*>>」を指定して開始します。コメントには XML 形式の本文を含める必要があります。少なくとも、最初の行に <summary> タグを使用し、最後の行に </summary> タグを使用する必要があります。サポートされているその他のタグについては、MSDN で提供されている XML ドキュメント コメントに関する情報を確認してください。
ドキュメント コメントは、定義を提供するネームスペース、型、またはメンバーの宣言の直前に追加する必要があります。
*>> <summary> *>> A namespace, class, or a method decscription *>> </summary> class-id ClassName public inherits type MyNamespace.MyType...
特定のネームスペースについて記述する場合は、$set を使用してコードで直接指定する必要があります。プロジェクトのプロパティの [XML documentation file] プロパティでは指定できません。次に例を示します。
*>> <summary> *>> This namespace includes all the types dealing with MFUNIT *>> </summary> $set ilnamespace"MicroFocus.COBOL.MFUNIT.Framework"
次の例は、クラスとその 2 つのメソッドのドキュメント コメントを示しています。
*>> <summary> *>> SuccessException - Exception thrown if the test case ends with a sucess condition *>> </summary> class-id SuccessException public inherits type Exception attribute Serializable . *>> <summary> *>> SuccessException - constructor with no assert message *>> </summary> method-id New. procedure division. invoke super::New("") end method. *>> <summary> *>> SuccessException - constructor with assert message *>> </summary> *>> <param name="msg">message</param> method-id New. procedure division using by value msg as string. invoke super::New(msg) end method. end class.