FILE ... TOC

Usual preprocess commands

You usually want normal comments in your source file that should remain unnoticed by esd and other comments that are part of the documentation. Therefore I recommend that you use a start string like:

  • {POD for PASCAL
  • /*COD for C
  • C FOD for FORTRAN

The end string can be

  • EPOD} for PASCAL
  • ECOD*/ for C
  • C EFOD for FORTRAN

PASCAL and C needs no preprocess command as the comment lines can contain the documenation in the format required by esd. However languages like FORTRAN or some BASIC dialects require each comment lines starting with special strings. Fortran comments should start with a C character in the first position. This should be removed before processing embedded source documentation. The line in the sdd file 

PreprocessComment = 's/^C//'
should process each documentation comment line and remove the leading C before processing for html generation. The FORTRAN files, of course remain intact.

FILE ... TOC