Forum Discussion
TanyaYatskovska
SmartBear Alumni (Retired)
Thanks for sharing this, BenoitB. I've added this great topic to the TechConer area.
Several questions:
- I don't see any comments inside a function. Do you explain all the actions you do in the code before the function? Sorry, perhaps, it's listed in French, but I don't understand.
- Have you ever used any code documentation tools? What was your experience?
BenoitB
5 years agoCommunity Hero
Hello TanyaYatskovska
About comments; yes it's true you should comment when it's NOT trivial only. But as i prepare another post on General guidelines for scripting i've not speak about comments here. It's more on what's your standard way of building a robust and clean function.
About documentation tools, i use a nodeJs jsdoc module that i've tweaked, a sample of the result is here:
i'll write another post on this subject later, it's planned ;)
Related Content
- 6 years ago
- 2 years ago
Recent Discussions
- 19 hours ago
- 20 hours ago
- 5 days ago