Gromacs

Comments In Code

    Table of contents
    No headers

    Version as of 00:25, 25 Aug 2019

    to this version.

    Return to Version archive.

    View current version

    In order to finally have a real development manual we need to automate the process of generating a cross-linked index of functions. doxygen can do that, but it requires special format comments in all the header files. It would also be good to check which functions are used only from their own C file, (i.e. test whether they can be made static).

    In general, spend time explaining WHY, not how. Explain the algorithm you use for your fancy new sort algorithm and provide a reference to it, rather than writing "go through all elements" before the for-loop. Most programmers will figure out the latter after a minute anyway :-)

    Page last modified 11:05, 21 Mar 2009 by rossen