diff options
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r-- | doc/developer-guidelines.sgml | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 1861e956..6d5c813c 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
@@ -643,9 +643,16 @@ setup the tests. Run "make test" to run all the tests. | |||
643 | <section id="CodingGuidelines"><title>Coding guidelines</title> | 643 | <section id="CodingGuidelines"><title>Coding guidelines</title> |
644 | <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU | 644 | <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU |
645 | Coding standards</ulink> for general guidelines.</para> | 645 | Coding standards</ulink> for general guidelines.</para> |
646 | <section><title>Comments</title> | 646 | <section><title>C coding</title> |
647 | |||
648 | <para>Variables should be declared at the beginning of code blocks and | ||
649 | not inline because of portability with older compilers.</para> | ||
650 | |||
647 | <para>You should use /* */ for comments and not // as some compilers | 651 | <para>You should use /* */ for comments and not // as some compilers |
648 | do not handle the latter form.</para> | 652 | do not handle the latter form.</para> |
653 | </section> | ||
654 | |||
655 | <section><title>Crediting sources</title> | ||
649 | <para>If you have copied a routine from another source, make sure the licence | 656 | <para>If you have copied a routine from another source, make sure the licence |
650 | from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS | 657 | from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS |
651 | file, where you can put more detail about the source.</para> | 658 | file, where you can put more detail about the source.</para> |