Quentin Mathé wrote:
Link:
<http://www.etoile-project.org/etoile/mediawiki/index.php?title=How_to_contribute_with_code>
Feedback welcome. By the way, if there is no particular disagreement, I
think we can make these Guidelines official, in other words mandatory
for any new modules to be included in the repository.
Some feedback for you...
*) Drop TABs entirely. Makes life easier for all IMHO
*) Changelog lines should have *two* spaces between date & name and
between name & email
2006-06-19 Sheldon Gill <[EMAIL PROTECTED]>
as I understand it, this is the GNU convention BTW
*) Specify indentation amount (4 chars, 8 chars...)
*) Should make asterisks line up like:
/*
* VERY important single line comment
*/
*) Further attention comments should have commentor noted
// FIXME: say who added the comment -SG
*) In the Accessors section the code example has a single line comment
which uses double slashes instead of the recommended single line
/* copy objects from the NSArray to the buffer */
Messages/Methods Arrangement does the same thing so should be
/* Other instance methods */
Might I recommend that this document also be expanded, or linked to additional
information, to cover:
a) documenting code
b) module layout
c) debug coding (use of logs, exceptions etc)
d) use of C int type and use of pointers generally (esp for 64-bit clean)
Just some thoughts and ideas.
Regards,
Sheldon
_______________________________________________
Etoile-dev mailing list
[email protected]
https://mail.gna.org/listinfo/etoile-dev
