fpt Reference: FORMAT HEADER COMMENTS

fpt and WinFPT Reference Manual - Command-line Commands

| SimCon Home | Ref Manual Home |

FORMAT HEADER COMMENTS

Syntax:

[ DO NOT ] FORMAT HEADER [ COMMENTS ] [ DO NOT ] INDENT HEADER [ COMMENTS ] [ DO NOT ] INDENT HEADERS [ DO NOT ] REFORMAT HEADER [ COMMENTS ]

Function:

Controls whether or not fpt reformats header comments in the same way as comments within the code body of a file. Header comments are considered to be all comments written before the first statement in a file which is not an OPTIONS, PROGRAM, BLOCK DATA, SUBROUTINE, FUNCTION or MODULE statement.

By default, comments within the body of a file are indented to the same level as the code according to the following rules:

If, in fixed format, the original comment starts before the end of the label field it is transcribed without modification;
If the original comment starts after the label field in fixed format, or the input code is written in free format, the comment is indented to the same level as the code. Thus, for example, if the code is indented by 10 spaces, 6 for the label field and 2 each for two levels of DO loop nesting, the comments are also indented by 10 spaces.

The commands REFORMAT HEADER COMMENTS, INDENT HEADER COMMENTS and INDENT HEADERS are synonyms for FORMAT HEADER COMMENTS.

Indentation of all comments may be suppressed by the command DO NOT INDENT COMMENTS.

Where to Use this Command

Operating system command line	Yes
Configuration file, config.fsp	Yes
Specification (fsp) files, *.fsp	Yes
Interactively, to FPT> prompt	Yes
Interactive command files	Yes
Embedded in the Fortran code	Yes

Default

DO NOT FORMAT HEADER COMMENTS

(Note that defaults may be changed in the configuration file)