Hacker News new | ask | show | jobs
by joshink1 1613 days ago
I've enjoyed reading the Guacamole client code (JS): https://github.com/apache/guacamole-client/blob/master/guaca...

Clean and consistent formatting, detailed comments, sensible modularization -- and it works well

1 comments

oh thanks for giving a great example definitely well written code. been reading this https://github.com/apache/guacamole-client/blob/master/guaca...

don't you find that comments are taking a lot of space more than the actual code or do you think this is what a takes to avoid confusion. I found that single line comments are much better, compact and enough to explain what is happening as opposed to those multiline comments that take so much space.

The multi-line comments follow JSDoc syntax, which many IDEs can parse to give the developer useful suggestions. https://jsdoc.app/about-getting-started.html