Intel® Fortran Compiler
Build applications that can scale for the future with optimized code designed for Intel® Xeon® and compatible processors.
Announcements
FPGA community forums and blogs on community.intel.com are migrating to the new Altera Community and are read-only. For urgent support needs during this transition, please visit the FPGA Design Resources page or contact an Altera Authorized Distributor.

Documenting a fortran program.

Ilie__Daniel
Beginner
1,433 Views
Hello!

I was give a fortran program which I have to document.
Is there a special way to write the comments so that they could be generated into a document?

In C# one can use the triple slash /// to generate documentation for methods in XML format. Using an extension such as GhostDoc can speed up the process.

Are there any know extension for Visual Studio 2010 that would work for fortran programs?

Do you have any other suggestions?

Thank you for your help with this.
0 Kudos
7 Replies
Arjen_Markus
Honored Contributor II
1,433 Views
I suggest you have a look at general tools like ROBODoc and Doxygen as alternatives.

Regards,

Arjen
0 Kudos
jimdempseyatthecove
Honored Contributor III
1,433 Views
! /// Would this work with GhostDoc?

Jim Dempsey
0 Kudos
DavidWhite
Valued Contributor II
1,433 Views
I recommend RoboDoc. I have worked with the main developers to ensure that it works well for Fortran (as well as Aspen Custom Modeller, for anyone interested).

David
0 Kudos
Ilie__Daniel
Beginner
1,433 Views
I do not know Jim.
Probably not as this should be first supported by the Fortran parser.

Daniel Ilie.
0 Kudos
Ilie__Daniel
Beginner
1,433 Views
Thank you all for your suggestions.

Daniel.
0 Kudos
jimdempseyatthecove
Honored Contributor III
1,433 Views
Daniel,

In free format "! /// ..." is a comment
In fixed format use "C /// ..."

The rest is up to your external document parser.
I assume the document parser you mentioned accepts:

blah blah blah /// document this

Jim
0 Kudos
Steven_L_Intel1
Employee
1,433 Views
You can use ! in both forms.
0 Kudos
Reply