Re: Doxygen comments in C++ source
| Newsgroups | gmane.comp.audio.supercollider.devel |
|---|---|
| Message-ID | <CAO9Q0tVEnOoZfiVSuifHcayDsxBv-Sh9hApKSBhGtxW-_ZpKSQ@mail.gmail.com> |
Without weighing in on what format the documentation should be in, or how mandatory adding it should be, may I just say my heart leaps every time I see a new explanatory comment in the server code. bce7432 and 891fcbc are a couple of nice recent examples. Tom On Thu, Feb 8, 2018 at 4:16 PM, <julian.rohrhuber-QYZGCWsIODmAF8UT6DzBU6xOck334EZe@public.gmane.org> wrote: > > > On 08.02.2018, at 19:12, [email protected] wrote: > > > > > so i guess my proposal would be, write Doxygen comments if you really > feel like it, but with the understanding that it's temporary. either way, > code quality comes first. > > > > "code quality comes first" is only meaningful once we have standards on > "code quality". Right now the guidelines are very slim and not enough to > really amount to quality code, IMO. If you really believe this, then we > ought to spend time working on those. > > > I can help with this on the sclang side, if we decide to work on this. I > think it can't be very detailed, because many of the really important > factors either are case specific or aesthetic. > > > >