Herramienta para generar documentación angular que se puede buscar a través de etiquetas

Trabajo en una empresa y tenemos muchos proyectos que usan angularjs. Mi problema aquí es que somos alrededor de 30 desarrolladores y es bastante difícil estar al tanto de todas las directivas/componentes/servicios que ya existen en algunos proyectos y no crearlos dos veces.

Estoy buscando una herramienta que pueda ayudarme a buscar mis directivas/componentes/servicios a través de etiquetas y creo que la forma más fácil sería escribir comentarios que contengan estas etiquetas y luego generar una documentación que me permita buscarlas. Más de algo que nos ayude a comprobar que lo que queremos conseguir no existe ya.

¿Tiene alguna idea de la mejor manera de lograrlo?

Perdóneme si tal cosa es obvia, pero no sé mucho sobre herramientas de documentación. ngDocs no es lo que estoy buscando.

Respuestas (1)

Puede usar fácilmente ngDocs o JSDoc . De esa manera, podrá generar una documentación, por ejemplo, con jsdoc helper . Para etiquetar puede usar JSDoc @aliaso simplemente @namepor ejemplo.

Una vez que lo instaló a través de npmust, ejecute:

jsdoc yourJavaScriptFile.js

ejemplo de 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>
Jaja eres tú otra vez. Bueno, realmente no entiendo cómo funciona entonces.
Proporcioné un ejemplo simple. La documentación debe guiarlo. Si tiene problemas con la implementación/ejecución -> vuelva a stackoverflow y cree preguntas que incluyan un intento simple y códigos sobre su problema. ;)
No sé si me entendiste cuando hablo de etiquetas. Me gustaría definir mis propias etiquetas y luego buscar las directivas etiquetadas con esas palabras. Tal vez algo parecido a la búsqueda de hashtags en Twitter. ¿Estos documentos me permitirán hacer eso?
Sí, lo sé, podría usar JSDoc - usejsdoc.org/tags-alias.html para que esto funcione. También puede extender jsdoc con una etiqueta propia @tagpara que funcione según sus requisitos.
Herramienta para generar documentación angular que se puede buscar a través de etiquetas
RespuestasAquíPolítica de privacidad1y, 0v