ford

福特

这是现代福特程序的自动文档生成器。福特代表Fortran纪录片。如您所知，“福特”是指越过河（或其他水域）。在这种情况下，它并不是指任何与汽车相关的公司或个人。

由于Doxygen对Fortran的处理不佳以及缺乏可比的替代方案，福特之所以撰写。 RoboDoc实际上无法从源代码中提取任何信息，我发现的几乎任何其他自动文档软件都是专有的，对于Fortran来说不是很好，或者在其产生如何产生的方面受到限制。 F90DOC非常好，我设法修改了它，以便它可以处理大多数Fortran 2003，但是它会产生相当丑陋的文档，无法与文档的不同部分之间提供尽可能多的链接，并且用Perl编写（我不太熟悉，并且在Python中不太熟悉，并且在Python中发现了用于生产HTML内容的那种图书馆）。

福特的目的是能够可靠地为现代Fortran软件制作文档，这是信息丰富且愉快的文档。该文档应易于编写和在代码中不可撰写。虽然它永远不会像Doxygen那样丰富功能，但希望福特能够为记录Fortran项目提供一个很好的替代方法。

功能

当前功能包括：

• 从源代码中提取有关变量，过程，过程参数，派生类型，程序和模块的信息的能力。
• 从源代码中的注释中提取文档的能力。
• 使用Mathjax的文档中的乳胶支持。
• 可搜索的文档，使用LUNR搜索。
• 作者描述和社交媒体（包括github！）链接。
• 链接以下载源代码。
• 链接到单个文件的链接，无论是其原始形式还是在HTML中进行语法突出显示。
• 将降价用于类型存储文档。
• 软件相关部分之间的链接。
• Bootstrap CSS用于文档，使其既有功能又漂亮。
• 可配置的设置。
• 能够创建包含一般信息的层次结构集，而与源代码的任何特定部分无关。
• 显示具有文件级文档和语法突出显示代码的非Fortran源文件的条目。

安装

安装福特的最简单方法是使用PIP：

 pip install ford

PIP将自动为您处理所有依赖关系。默认情况下，这将把ford放在~/.local/bin中 - 您可能需要将其添加到PATH中。

另外，可以通过Mac OS X的Homebrew Package Manager获得福特。要更新Homebrew并安装福特，请在终端中运行这些命令：

 brew update
brew install FORD

如果brew install --HEAD FORD想从GitHub安装最新的开发项目（Master --HEAD分支

通过运行以下命令，也可以通过SPACK软件包管理器获得福特：

 spack install py-ford

文档

更完整的文档可以在文档中找到。

执照

该程序是免费的软件：您可以根据自由软件基金会发布的GNU通用公共许可证的条款对其进行重新分配和/或修改它，该版本是该许可证的版本3，或（按您的选项）任何以后的版本。

该程序的分布是希望它将有用的，但没有任何保证；即使没有对特定目的的适销性或适合性的隐含保证。有关更多详细信息，请参见GNU通用公共许可证。

您应该已经收到了GNU通用公共许可证的副本以及此计划。如果没有，请参见GNU网站。

福特生产的文件是从其生产中使用的输入得出的衍生作品；他们不受此许可的影响。