12

YAMLファイルをドキュメント化するためのjavadocやrdocのようなものがありますか？それをHTMLドキュメントに抽出できますか？理想的にはマークダウン構文を使用します。

4

1 に答える 1

7

概要

質問へのコメントに示されているように、一般的に言えば、YAMLをドキュメント化するために必要なのは、ドキュメントまたはメタデータ専用のYAMLコンテンツのセクションを作成することだけです。

唯一の注目すべき課題は、ドキュメントセクションを、コードをドキュメント化するためのさまざまな構文スタイル（Doxygen、NaturalDocsなど）のいずれかの規則に準拠させるかどうかを決定することです。

この問題領域にはさまざまなアプローチがあります。別のアプローチは、この回答の「関連項目」セクションに示されています。

例

YAMLでメタデータセクションを作成するのは非常に簡単です。すべてのドキュメントを単一のブロックとしてダンプするインライン文字列を作成するだけで作成できます。

  ## comments
  ## NOTE: YAML generally throws your comments away, so they are not very useful
  ## for round-trip metadata

  meta: | 
     Here is all my documentation and metadata
     blah blah blah.

  data: 
     branch_one: 
        - caption: blah blah
          date: blah blah
          details: blah blah

        - caption: blah two
          date: blah blah
          details: blah blah

     branch_two: 

  [..]

も参照してください

于 2011-12-19T17:45:57.880 に答える