Tool zum Generieren von Winkeldokumentationen, die über Tags durchsucht werden können

Ich arbeite in einem Unternehmen und wir haben viele Projekte, die anglejs verwenden. Mein Problem hier ist, dass wir ungefähr 30 Entwickler sind und es ziemlich schwierig ist, sich aller Anweisungen/Komponenten/Dienste bewusst zu sein, die bereits in einigen Projekten vorhanden sind, und sie nicht zweimal zu erstellen.

Ich suche nach einem Tool, das mir helfen könnte, über Tags nach meinen Anweisungen/Komponenten/Diensten zu suchen, und ich denke, der einfachste Weg wäre, Kommentare zu schreiben, die diese Tags enthalten, und dann eine Dokumentation zu erstellen, mit der ich danach suchen kann. Eher etwas, das uns hilft zu überprüfen, ob das, was wir erreichen wollen, nicht bereits existiert.

Haben Sie eine Idee, wie Sie das am besten erreichen?

Entschuldigen Sie, wenn so etwas offensichtlich ist, aber ich weiß nicht viel über Dokumentationswerkzeuge. ngDocs ist nicht das, wonach ich suche.

Antworten (1)

Sie könnten einfach ngDocs oder JSDoc verwenden . Auf diese Weise können Sie zB mit jsdoc helper eine Dokumentation erstellen . Zum Taggen können Sie zum Beispiel JSDoc @aliasoder einfach nur verwenden @name.

Sobald Sie es über npmust installiert haben, führen Sie Folgendes aus:

jsdoc yourJavaScriptFile.js

ngDocs-Beispiel

<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>
Haha du bist es wieder. Nun, ich verstehe nicht wirklich, wie es dann funktioniert.
Ich habe ein einfaches Beispiel gegeben. Die Dokumentation soll Sie leiten. Wenn Sie Probleme mit der Implementierung / Ausführung haben -> wechseln Sie zurück zu Stackoverflow und erstellen Sie eine Frage mit einem einfachen Versuch und Codes zu Ihrem Problem. ;)
Ich weiß nicht, ob Sie mich verstanden haben, wenn ich von Tags spreche. Ich möchte meine eigenen Tags definieren und dann die markierten Anweisungen mit diesen Wörtern durchsuchen. Etwas in der Nähe der Twitter-Hashtag-Suche vielleicht. Diese Dokumente erlauben mir, das zu tun?
Ja, ich weiß, Sie könnten JSDoc - usejsdoc.org/tags-alias.html verwenden , damit dies funktioniert. Sie können jsdoc auch mit einem eigenen Tag erweitern @tag, damit es für Ihre Anforderungen funktioniert.
Tool zum Generieren von Winkeldokumentationen, die über Tags durchsucht werden können
AntwortenHierDatenschutz-Bestimmungen1y, 0v