I am trying to figure out how and how much I should comment my node module. To learn from others, I took a look at a npm-package, main-bower-files <https://github.com/ck86/main-bower-files>.
I see that package_collection.js and package.js are well documented in the style that I see on usejsdoc.org. But the main file, index.js is not commented at all. The first files are objects with constructors, methods and such, but the main file index.js has not, but it has a couple of paramenters, Is it only modules with objects with methods and such API-related stuff that should get such comment-documentation? And/or is it perhaps because the the README-file has a description on how to use the main file (index.js) then there is no need to make any comment-documentation in the index.js? Any thoughts would be much appreciated! Frode -- Job board: http://jobs.nodejs.org/ New group rules: https://gist.github.com/othiym23/9886289#file-moderation-policy-md Old group rules: https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines --- You received this message because you are subscribed to the Google Groups "nodejs" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/nodejs/fbd175ac-73e5-4255-a5ec-53ee56a58417%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
