Кто-нибудь разрабатывает инструменты для создания документации по элементам?

Вроде как javadocs, но для полимерных элементов.

У меня такое чувство, что они были созданы из инструмента http://www.polymer-project.org/docs/elements/polymer-elements.html http://www.polymer-project.org/docs/elements/polymer-ui-elements.html

Если нет инструментов, которыми вы можете поделиться конкретно, возможно, кто-то может поделиться описанием подхода. XSLT?

2 3
polymer

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

0

Мы находимся в процессе очистки этих вещей и документирования инструментов документации только в ближайшие пару недель. Мне жаль, что сегодня все это немного грубо. Сказав это, вот некоторая информация:

Полимер вендс а 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 (модель данных), чтобы вы могли визуализировать его так, как вам нравится.

3