2

I work in a company and we have a lot of projects that are using angularjs. My issue here is that we are around 30 devs and it is quite hard to be aware of all directives/components/services that already exists in some projects and not to create it twice.

I'm searching for a tool that could help me search for my directives/components/services via tags and I think the easiest way would be to write comments that contains theses tags and then generate a documentation that allows me to search for them. More of something that help us verifying that what we want to achieve does not already exixts.

Do you have any ideas of the best way to achieve that ?

Pardon me if such a thing is obvious but I don't know much about documentation tools. ngDocs is not what I'm searching for.

1

You could easily use ngDocs or JSDoc. In that way you will be able to generate a documentation e.g. with jsdoc helper. For tagging you can use JSDoc @alias or just @name for example.

Once you installed it via npm ust run:

jsdoc yourJavaScriptFile.js

ngDocs example

<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>
  • 1
    Haha it's you again. Well I don't really unterstand how it works then. – Groben Apr 6 '17 at 11:49
  • 1
    I provided an simple example. The documentation should guide you. If you have problems with the implementation / execution -> switch back to stackoverflow and create a questions including an simple attemp and codes about your problem. ;) – lin Apr 6 '17 at 11:52
  • I don't know if you unterstood me when I'm talking about tags. I'd like to define my own tags then search the tagged directives with thoses words. Something close to twitter hashtag search maybe. These docs will allow me to do that ? – Groben Apr 6 '17 at 11:54
  • Yea i know, you could use JSDoc - usejsdoc.org/tags-alias.html to make this work. You could also extend jsdoc with an own tag like @tag to make it work for your requirements. – lin Apr 6 '17 at 11:55

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.