2017-09-28 3 views
0

私は現在、顧客向けにAPIドキュメントを作成するための代替ソリューションを評価しています。現在私たちは自家製のソリューションを使用しており、いくつかの研究を開始しました。これは、Microsoftが開発して使用しているDocFXに出会ったときです。DocFX(VB.net) - インラインコメントのサポート

は事実のためにどこにもありませんでしたを除いて、私は、次の例のように、インラインコメントを含めについて言及見ることができ、非常に便利思えた:

Enum Test 
Value1= 0 ' This is a sample comment 
End Enum 

特に列挙型で、これを必要とする理由は、これはどのようにされています私たちは、ドキュメンテーション内に一般に公開されることを希望するコメントを入れています。ここで

+0

インラインコメントは、マイクロソフトのメタデータ生成器によって抽出されていません。明らかにDoxygenはそれを行うことができますが、私はそれをテストしていません。 – Schwarzie2478

答えて

0

は例です:docfxはそれらを拾うことができることはありませんので、

vb ''' <summary> ''' egg size enum ''' </summary> Public Enum EggSizeEnum ''' <summary> ''' jumbo ''' </summary> Jumbo ''' <summary> ''' extra large ''' </summary> ExtraLarge Large Medium Small End Enum