Reminder of no inline variable declarations

git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@1400 f882894a-f735-0410-b71e-b25c423dba1c
This commit is contained in:
Ton Voon 2006-05-24 09:23:50 +00:00
parent f7bb6d16e6
commit 49f15b6bbf

View file

@ -643,9 +643,16 @@ setup the tests. Run "make test" to run all the tests.
<section id="CodingGuidelines"><title>Coding guidelines</title>
<para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU
Coding standards</ulink> for general guidelines.</para>
<section><title>Comments</title>
<section><title>C coding</title>
<para>Variables should be declared at the beginning of code blocks and
not inline because of portability with older compilers.</para>
<para>You should use /* */ for comments and not // as some compilers
do not handle the latter form.</para>
</section>
<section><title>Crediting sources</title>
<para>If you have copied a routine from another source, make sure the licence
from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS
file, where you can put more detail about the source.</para>