Models Methods Software

Coding Guidelines and Inline Documentation: GISS ModelE

Here’s an example of what a lack on coding guidelines (or ignoring them) can lead to. From the NASA/GISS ModelE online source code browser:

SUBROUTINE SURFCE 1,30
!@sum SURFCE calculates the surface fluxes which include
!@+ sensible heat, evaporation, thermal radiation, and momentum
!@+ drag. It also calculates instantaneous surface temperature,
!@+ surface specific humidity, and surface wind components.
!@auth Nobody will claim responsibilty

This is the entire header information for a 1228-line routine.

The last line says it all.

August 9, 2007 - Posted by Dan Hughes | Uncategorized | Code Documentation, Code Verification, Coding standards, GISS ModelE Coding