## 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:
[..]
As it appears in the comments to the question, generally speaking, all that is necessary for documenting YAML is to create a section of the YAML content devoted specifically to documentation or metadata.
The only noteworthy challenge is determining whether you want your documentation section to conform with the conventions of any of the various syntax-styles for documenting code (e.g., Doxygen, NaturalDocs, whatever).
There are various approaches to this problem domain. Alternate approaches are indicated in the "See also" section of this answer.
Example
Creating a metadata section in YAML is very straightforward, you can do it simply by creating an inline string where you dump all your documentation as a single block.
## 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:
[..]
发布评论
评论（1）
概述
正如该问题的评论中所示，一般来说，记录 YAML 所需的只是创建专门用于文档或元数据的 YAML 内容部分。
唯一值得注意的挑战是确定您是否希望您的文档部分符合用于记录代码的各种语法样式的约定（例如，Doxygen、NaturalDocs 等）。
解决这个问题领域有多种方法。本答案的“另请参阅”部分指出了替代方法。
示例
在 YAML 中创建元数据部分非常简单，您只需创建一个内联字符串即可将所有文档转储为单个块。
另请参阅
Overview
As it appears in the comments to the question, generally speaking, all that is necessary for documenting YAML is to create a section of the YAML content devoted specifically to documentation or metadata.
The only noteworthy challenge is determining whether you want your documentation section to conform with the conventions of any of the various syntax-styles for documenting code (e.g., Doxygen, NaturalDocs, whatever).
There are various approaches to this problem domain. Alternate approaches are indicated in the "See also" section of this answer.
Example
Creating a metadata section in YAML is very straightforward, you can do it simply by creating an inline string where you dump all your documentation as a single block.
See also