On Thu, Jul 07, 2016 at 04:19:33PM -0400, David G. Simmons 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?
We definitely need to do a better job with comments. The coding
standards document contains this clause:
All public APIs should be commented with Doxygen style comments
describing purpose, parameters and return values. Private APIs need
not be documented.
Do you think the language needs to be stronger or more specific?
Thanks,
Chris
