And just in case you think commenting your code is boring and pointless, here’s a fun reason to do it … you just never know. The code that took the USA to the moon was just posted on GitHub, and some of the code comments are pure gold!
http://qz.com/726338/the-code-that-took-america-to-the-moon-was-just-published-to-github-and-its-like-a-1960s-time-capsule/?utm_source=qzfb > On Jul 8, 2016, at 11:37 AM, aditi hilbert <[email protected]> wrote: > > Hi David, > > #mynewt on irc.freenode.net <http://irc.freenode.net/>. > See you there! > > thanks, > aditi > > >> On Jul 8, 2016, at 6:46 AM, David G. Simmons <[email protected]> wrote: >> >> What is the IRC channel? Can’t find a reference to it. >> >> I’ve read all the docs, to be sure. it’s down in the weeds of the code that >> some documentation would help most though. The docs referenced are way too >> high-level for where I’m digging. >> >> Best regards, >> dg >> >>> On Jul 8, 2016, at 5:09 AM, Nges B <[email protected]> wrote: >>> >>> Hello David. >>> >>> a +1 to the Idea on comments. It helps everyone working on the code >>> to easily understand what you were doing or is doing. >>> >>> But for the time being, here is a link to the documentation of all >>> (or most ) already existing modules in our project. >>> >>> http://mynewt.apache.org/latest/os/introduction/ >>> >>> in case you do not understand anything from there, ask the community. >>> It is a very friendly one. >>> >>> Ask over the mailing list or IRC Channel . >>> >>> Thanks >>> >>> On 7/7/16, David G. Simmons <[email protected]> wrote: >>>> >>>> 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 • Blog • Linkedin • Twitter • GitHub >> /** Message digitally signed for security and authenticity. >> * If you cannot read the PGP.sig attachment, please go to >> * http://www.gnupg.com/ Secure your email!!! >> * Public key available at 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. >> >> > -- David G. Simmons (919) 534-5099 Web • Blog • Linkedin • Twitter • GitHub /** Message digitally signed for security and authenticity. * If you cannot read the PGP.sig attachment, please go to * http://www.gnupg.com/ Secure your email!!! * Public key available at 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
