有人开发过生成元素文档的工具吗

Question

有点像javadocs，但适用于聚合物元素。

我感觉这些都是从一个工具中产生的http://www.polymer-project.org/docs/elements/polymer-elements.htmlhttp://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/ppolymer-dew/NFQ4hIgZSo4/bBVvMD6_jMEJ

有人对元件中未使用的锅炉板的数量表示担忧。这最终导致了文档查看器元素的原型

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