Code Comments
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
I know I'm new around here, so I'd ask that you be patient with me. Of
the two dozen or so source code files I've looked through so far in
trying to learn how the GIMP code works, it seems like most of the app
code is not even moderately commented. There is the rare snippet here
and there explaining a block or a variable, but little that really
narrates the code. (From what I've seen, the plug-in code is generally
better commented than the app code.)
So, two main questions here: first, what is the working philosophy
around here about code comments? Are we preferring more of a "well
written code should explain itself" approach? Are we inclined to accept
patch submissions that simply add comments to code? Are there guidelines
for what code comments should be like?
Second, if new developers can't figure out what a piece of code does, or
where some functionality is, should we ask on this list? (That's
actually not a hypothetical question in my case...)
- --
Christopher Howard
http://indicium.us
http://theologia.indicium.us
I digitally sign /all/ my e-mails via PGP. If you receive any e-mail
supposedly from me without my valid PGP digital signature, please take
additional steps to verify the authenticity of the message.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iEYEARECAAYFAkqJsmQACgkQQ5FLNdi0BcU2jACfUXymdVs7HEVq9I7j1V6EUu74
1XwAoIVDqfIZIjft27Ws/lmHmkLn6dci
=pl84
-----END PGP SIGNATURE-----
