Daichi Kawahata wrote: > Note that, at almost of all, I'm following the attached style guidance > (commenting_style.txt) from doc/devguide/STYLE, but some files are > heavily modified at the initial comment box, especially Michael's ones > what I've attached as an example (src/ui/gtk/gtk1/search_stats.c), if > you feel your comments may be messed up by the modification, let me > know.
I see nothing problematic in those changes. Some of the comments could actually be removed. You've added "Needs a short description" and then follows what looks to me like a short description. Isn't that comment sufficient as a short description or is "short description" supposed to be something like a headline i.e., shorter than a sentence? > Of course, it brings certain benefits e.g. it can be easily understood > role of each files (files.html), related functions, macro values (but > for me at now...) and check one-stop TODO list through a browser. The TODO list extraction is certainly an advantage. However, I'd prefer if TODO, FIXME, XXX are kept nonetheless because these stand out in Vim by default. -- Christian
pgpu8AVxTNt1J.pgp
Description: PGP signature
