文章/答案/技术大牛

发布

社区首页 >问答首页 >记录yaml

问记录yaml
EN

Stack Overflow用户

提问于 2011-07-06 02:50:04

回答 1查看 5.7K关注 0票数 12

有没有像javadoc或rdoc这样的东西来记录YAML文件，以便我们可以将其提取到HTML文档中？理想情况下，使用markdown语法。

yaml

rdoc

documentation

javadoc

回答 1

Stack Overflow用户

回答已采纳

发布于 2011-12-20 01:45:58

概述

正如问题的注释所示，一般而言，记录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: 

  [..]

另请参阅

票数 7

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/6587421

复制

相似问题

问记录yaml
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问记录yamlEN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问记录yaml
EN