Инструмент для создания угловой документации с возможностью поиска по тегам.

Я работаю в компании, и у нас много проектов, использующих angularjs. Моя проблема здесь в том, что нас около 30 разработчиков, и довольно сложно быть в курсе всех директив/компонентов/сервисов, которые уже существуют в некоторых проектах, и не создавать их дважды.

Я ищу инструмент, который мог бы помочь мне искать мои директивы/компоненты/сервисы с помощью тегов, и я думаю, что самым простым способом было бы написать комментарии, содержащие теги тезисов, а затем создать документацию, которая позволит мне их искать. Больше того, что поможет нам убедиться, что то, чего мы хотим достичь, еще не существует.

Есть ли у вас какие-либо идеи о наилучшем способе достижения этого?

Простите меня, если это очевидно, но я не очень разбираюсь в инструментах документирования. ngDocs - это не то, что я ищу.

Ответы (1)

Вы можете легко использовать ngDocs или JSDoc . Таким образом, вы сможете создать документацию, например, с помощью помощника jsdoc . Для тегирования вы можете использовать JSDoc @aliasили просто @nameнапример.

После того, как вы установили его через npmus run:

jsdoc yourJavaScriptFile.js

Пример ngDocs

<doc:example> tag

<doc:example module="...">
  ...
  <doc:source>
    ...
    <script></script> <!-- Contents will be extracted into a script.js file -->
    ...
    <style></style> <!-- Contents will be extracted into a style.css file -->
    ...
  </doc:source>
  <doc:scenario>
    ...
  </doc:scenario>
</doc:example>
Ха-ха, это снова ты. Ну тогда я не совсем понимаю, как это работает.
Я привел простой пример. Документация должна помочь вам. Если у вас есть проблемы с реализацией / выполнением -> переключитесь обратно на stackoverflow и создайте вопросы, включая простую попытку и коды о вашей проблеме. ;)
Я не знаю, поняли ли вы меня, когда я говорю о тегах. Я хотел бы определить свои собственные теги, а затем выполнить поиск директив с тегами с помощью этих слов. Возможно, что-то похожее на поиск по хэштегу в твиттере. Эти документы позволят мне это сделать?
Да, я знаю, вы могли бы использовать JSDoc - usejsdoc.org/tags-alias.html , чтобы все заработало. Вы также можете расширить jsdoc с помощью собственного тега, например @tag, чтобы он работал в соответствии с вашими требованиями.
Инструмент для создания угловой документации с возможностью поиска по тегам.
СпросиСетьПолитика конфиденциальности1y, 0v