Gibt es ein Paket, mit dem Sie Ihre Gruntdatei dokumentieren können, ähnlich wie apiDocs für Node?

Question

Ich habe ein großartiges Projekt eingerichtet, mit Tonnen von Gruntaufgaben. Das Problem ist, es ist aufgebläht. Die gruntfile.js allein hat 1200+ Zeilen. Ich möchte in der Lage sein, alle diese Grunt-Plugins, die ich installiert habe, durch Anmerkungen in Code wie apiDocs zu dokumentieren. Gibt es irgendwelche Pakete, die das machen? Oder gibt es eine andere Möglichkeit, Ihre Grunt-Datei zu dokumentieren?

Answer 1

Wenn Ihre Gruntfile 1200 Zeilen lang ist, empfehle ich Ihnen dringend, split it into multiple files.

Sie Gruntfile ist einfach eine NodeJs App, was bedeutet, dass es in JS geschrieben ist und der beliebteste Dokumentator für JS ist JSDoc.

So könnte eine Aufgabe wie folgt aussehen:

Grunzen/

/** 
* Minify javascript files 
* 
* @description 
* Here is a detailed explanation of what this uglify task can do 
* 
* @type {Object} 
*/ 
module.exports = { 
    dist: { 
    files: { 
     'dist/build.min.js': ['dist/build.js'] 
    } 
    } 
};