search

peter-murray / node-hue-api

Node.js Library for interacting with the Philips Hue Bridge and Lights
Apache License 2.0
1.19k stars 145 forks source link

Comments markup #13

Closed darth-cheney closed 10 years ago

darth-cheney commented 10 years ago

Simple question: what is the markup you are using in code comments, particularly in index.js, and how does it work?

peter-murray commented 10 years ago

The code comments is a form of JSDoc, so that I had a form of code insight inside IntelliJ IDEA when I was writing the code. I have never run it through any JSDoc tooling to validate it, hence why I say a "form of".

IntelliJ IDEA utilizes these comments when you inspect the function parameters when coding, but it could be used to generate developer documentation, although I find it better to write a decent human language form of documentation, as I have done in the README.md file, or at least hope that is the case ;-)