As I’m working through all the mynewt code, something I’d love to see more of are comments in the code describing what’s going on, etc. I admit to not being the best at commenting my code — I’m working on it — but it would be really helpful, especially as more contributors join the party, to have well documented code so newbies like me can get up to speed on what the code is actually doing more quickly.
This would have the adde dbenefit of allowing us to use something like Doxygen to auto-generate documentation on the code in a more human-readable form. What do others think of implementing some code-documentation standards? dg -- David G. Simmons (919) 534-5099 Web <https://davidgs.com/> • Blog <https://davidgs.com/davidgs_blog> • Linkedin <http://linkedin.com/in/davidgsimmons> • Twitter <http://twitter.com/TechEvangelist1> • GitHub <http://github.com/davidgs> /** Message digitally signed for security and authenticity. * If you cannot read the PGP.sig attachment, please go to * http://www.gnupg.com/ <http://www.gnupg.com/> Secure your email!!! * Public key available at keyserver.pgp.com <http://keyserver.pgp.com/> **/ ♺ This email uses 100% recycled electrons. Don't blow it by printing! There are only 2 hard things in computer science: Cache invalidation, naming things, and off-by-one errors.
signature.asc
Description: Message signed with OpenPGP using GPGMail
