General code layout
These are a few general guidelines for how to organize your code:
- Group similar functions together into the same .c file.
- If a function will only be called from within the .c file where
it is defined, then include the prototype for the function in the
same .c file near the top. (see section
![[*]](/file/19772/2015-02-07.ftp.parl.clemson.edu.tar/ftp.parl.clemson.edu/pub/pvfs2/orangefs-2.8.3-20110323.tar.gz/orangefs-2.8.3-20110323.tar/orangefs/doc/coding/developer-guidelines.tex/crossref.png)
for
information on static declarations)
- If a function will be called from outside of the .c file in
which it is declared, then put the prototype in a header file
separate from the .c file. This header should be included in any
other .c file where the function will be called.
- Put comments describing the behavior of the function just
before its definition, not with the prototype (see section
for more detailed information about commenting
functions).
- Header files should only contain prototypes and structures
that are needed by external pieces of code. It helps to encapsulate things by not providing extraneous information in the
header files.