Hi Frode, Being reasonably new to the whole Node.js community (I have just implemented Node.js on a new platform - HP NonStop systems), I am rather dismayed at the lack of documentation in some areas (while I'm happy to say that some areas are documented well). It is very hard to document *too* much, so I would say "go nuts!!!". Maybe you could set a new standard :-) If you could also include lots of documentation in the code itself, that is also a huge help to any developers that might work on your code in the future (including yourself in 2 or 3 years time!).
My 2c worth :-) Dave On Tuesday, February 10, 2015 at 9:26:12 AM UTC+11, Mad Frode wrote: > > 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/39bf628d-1cdd-4269-bb0c-9d4f5997a3c1%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
