Question

有点像javadocs但是对于聚合物元素。

我感觉这些是从工具中生成的 http://www.polymer-project.org/docs/elements/polymer-elements.html http://www.polymer-project.org/docs/elements/polymer-ui-elements.html

如果没有专门分享的工具，也许有人可以分享方法的描述。 XSLT？

Answer 1

我们正在清理这些内容，并在接下来的几周内记录文档工具。对不起，今天的边缘有点粗糙。话虽如此，这里有一些信息：

Polymer会发布一个polymer-doc-viewer组件，您可以指向（一个或多个）HTML文件以从源注释生成文档。查看demo.html以查看可能的用法。

我们还有polymer-docs组件，它将为所有已知安装的聚合物元素呈现文档。这是在gh-pages安装的实时版本：

http://polymer.github.io/polymer-docs/components/polymer-docs/

评论格式与JSDoc类似，大多是从YUIDoc复制的。渲染的输出很快就会得到改善，但这是一个很好的部分：如果我们更改它然后你更新你的组件副本，它就会起作用。

您还可以自定义或制作自己的polymer-doc-viewer，因为代码非常简单。还有另一个名为context-free-parser的组件（包含在内），它实际上将文档数据变为JavaScript对象（数据模型），因此您可以随意呈现它。

Answer 2

有一个关于自我记录元素的提议。

https://docs.google.com/document/d/15erfuJ9kGTTFZIxM1E8mKSdvZmb9RPr2BwMQvU48PVI

给出了一些例子

<wc-documentation name="my-tag">
  <summary>My tag is the bees knees.</summary>
</wc-documentation>
<wc-documentation name="my-tag" version="0.0.1"
                  github="https://github.com/Polymer/polymer"
                  home="http://polymer-project.org">
  <summary>...</summary>
  <pre class="example">...</pre>
</wc-documentation>
<wc-documentation name="my-tag">
  <div class="api">
    <p>This element supports the following methods:</p>
    <dl public>
      <dt>foo()</dt>
      <dd>Awesome method.</dd>
    </dl>
    <dl private>
      <dt>bar_()</dt>
      <dd>Privacy is key.</dd>
    </dl>
  </div>
</wc-documentation>

在这里讨论

https://groups.google.com/forum/#!searchin/polymer-dev/documentation/polymer-dev/NFQ4hIgZSo4/bBVvMD6_jMEJ

元素内的锅炉板数量有些担忧。这最终导致了文档查看器元素的原型

http://polymer.github.io/polymer-doc-viewer/?//polymer.github.io/google-map/components/google-map/google-map.html&//polymer.github.io/polymer-localstorage/components/polymer-localstorage/polymer-localstorage.html

有人开发任何用于生成元素文档的工具吗？

2 个答案: