Polymer 有人开发了生成元素文档的工具吗?
有点像javadocs,但用于聚合物元素 我感觉这些都是由工具生成的Polymer 有人开发了生成元素文档的工具吗?,polymer,Polymer,有点像javadocs,但用于聚合物元素 我感觉这些都是由工具生成的 若并没有具体的工具可以共享,也许有人可以共享方法的描述。XSLT 有一个关于自我记录元素的提案 给出了一些例子 <wc-documentation name="my-tag"> <summary>My tag is the bees knees.</summary> </wc-documentation> <wc-documentation name="my-tag
若并没有具体的工具可以共享,也许有人可以共享方法的描述。XSLT 有一个关于自我记录元素的提案 给出了一些例子
<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>
我的标签是蜜蜂的膝盖。
...
...
此元素支持以下方法:
foo()
很棒的方法。
巴()
隐私是关键。
这里讨论
有人对元件内不必要的锅炉板数量表示担忧。这最终导致了文档查看器元素的原型
我们正在清理这些东西,并在接下来的几周内记录文档工具。我很抱歉,今天一切都有点不顺利。话虽如此,以下是一些信息: Polymer提供一个组件,您可以指向(一个或多个)HTML文件以从源注释生成文档。查看
demo.html
,了解一些可能的用法
我们还有一个组件,该组件将为您安装的所有聚合物元素提供文档。以下是安装在以下位置的实时版本:
注释格式类似于JSDoc,大部分是从YUIDoc复制的。渲染输出可能很快就会得到一次面部提升,但这是一个很好的部分:如果我们更改它,然后您更新组件的副本,它就会正常工作
您还可以自定义或制作自己的
polymer doc viewer
,因为代码非常简单。还有另一个组件(包括)称为上下文无关解析器
,它实际上将文档数据绑定到一个JavaScript对象(数据模型)中,这样您就可以随心所欲地呈现它了。这代表了两种我没有考虑过的方法,并在采用标准方法之前为我自己的需要提供了一些想法。谢谢你,马特!