Re: Code Documentation

2014-06-16 Thread Rajani Karuturi
IMO, comments are part of code. By writing code comments, we aren’t maintaining comments and code but rather helping others understand what the code is doing. As a developer, if I can easily understand what the code is doing, I won’t even look at the comments. In our codebase we have functions

RE: Code Documentation

2014-06-16 Thread Santhosh Edukulla
] Sent: Friday, June 13, 2014 10:59 AM To: dev@cloudstack.apache.org Subject: Re: Code Documentation On Wed, Jun 11, 2014 at 9:58 PM, Santhosh Edukulla < santhosh.eduku...@citrix.com> wrote: > Hi All, > > Many of code areas under CS, currently don't have enough documentation i &g

Re: Code Documentation

2014-06-13 Thread Rohit Yadav
On Wed, Jun 11, 2014 at 9:58 PM, Santhosh Edukulla < santhosh.eduku...@citrix.com> wrote: > Hi All, > > Many of code areas under CS, currently don't have enough documentation i > believe, we have few one liner comments at places. But, largely, was > missing at various code areas. > > We in one of