Am Dienstag, 11. Dezember 2007 06:57 schrieb Charles Day: > Do you like to see comments that reference the bugzilla bug number, as in > "For bug 12345: (explanation)"? Or leave the number off?
Including the bug number is indeed considered helpful. Feel free to add detailed explanations (probably not exceeding 3-4 lines, though.) > Do you want to see my name in there for future questions/blame, or do you > just leave that sort of history tracking to svn? I don't think the name is needed in the source code comments. I'd look up those things in the history, indeed. > If I have to analyze an uncommented section of code to figure out how it > works, can I add some comments to help the next pair of eyes, even if I am > not changing that code? The file I am working on is pretty slim on > comments. Yes, you can do that, but please make those a different (second) patch so that the bugfix is one patch on its own (with its included comments, but no extra comments). The same holds for indenting changes. > Is there some place that these and other coding policies are written down > so I can read them? I think the only written policies are in the text file HACKING. Christian _______________________________________________ gnucash-devel mailing list [email protected] https://lists.gnucash.org/mailman/listinfo/gnucash-devel
