Trac is being migrated to new services! Issues can be found in our new
YouTrack instance and WIKI pages can be found on our
website.
- Timestamp:
-
Aug 21, 2013, 2:07:43 AM (10 years ago)
- Author:
-
MarkDoliner
- Comment:
-
Update text about comments
Legend:
- Unmodified
- Added
- Removed
- Modified
-
|
v5
|
v6
|
|
| 41 | 41 | == Comments == |
| 42 | 42 | * A comment or two in the static (non-exported) functions is good, but not essential. |
| 43 | | * Every function added in any header file must be documented. See any of the header files in our tree for example. (If you find an undocumented or poorly documented function, please do submit a patch fixing it!) |
| | 43 | * Function declarations in header files must be documented. See our other header files for examples. (If you find an undocumented or poorly documented function, please do submit a patch fixing it!) |
| 44 | 44 | * Only use C89 comments, not C++/C99 one-line comments: |
| 45 | 45 | |
| 46 | 46 | {{{ |
| 47 | 47 | #!c |
| 48 | | // this kind of comment is not supported in C89, so cannot be used in our codebase. |
| | 48 | // don't use this style--we don't like it |
| 49 | 49 | |
| 50 | 50 | /* Use this kind of comment for a single line... */ |
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!
