|
InterfacesTable of contentsNo headersThe interfaces (header files) to code should be completely self-explanatory. For an example see the Encapsulation page. It should obviously have a descriptive name and not be identical to system include files. Prepending everything with gmx_ may suffice to reach this goal. It is also important that routines should do what a naive user thinks they will do, not more and not less. For instance, do you think that (1) the orchard will be in sorted order after calling gmx_orchard_sort(), and (2) the order in the orchard will silently have changed to sorted after calling gmx_orchard_print()? |