ford代表fortran文档管理器,是现代fortran程序的自动文档生成器。

FORD的Python项目详细描述


这是现代Fortran的自动文档生成器 程序。福特代表Fortran文档管理器。如你所知,“去福特” 指穿越河流(或其他水体)。不,在 本文中,指与汽车相关的任何公司或个人。

福特是因为 Doxygen处理不当 Fortran和缺乏可比的替代品。 ROBODoc不能 实际上从源代码中提取任何信息 我发现的其他自动文档软件要么是专有的, 在fortran中工作得不太好,或者在如何工作方面受到限制 生产了它的产品。 f90doc很好,我 设法修改它,使它能够处理Fortran 2003的大部分内容,但是 它产生了相当难看的文档,不能提供那么多链接 在文档的不同部分之间 在Perl中(我不太熟悉它,它缺少 python中用于生成html内容的库)。

福特的目标是能够可靠地为 现代Fortran软件,信息量大,好看。这个 文档应该易于编写,并且在代码中不突出。 虽然它永远不会像多西根那样功能丰富,但希望福特会 能够为编制Fortran项目文档提供一个很好的选择。

能力

当前功能包括:

  • 能够提取有关变量、过程的信息, 过程参数、派生类型、程序和模块 源代码。
  • 从源代码中的注释中提取文档的能力 代码。
  • 在文档中使用乳胶支持 MathJax
  • 可搜索文档,使用Tipue Search
  • 作者描述和社交媒体(包括github!)链接。
  • 下载源代码的链接。
  • 以原始格式或HTML格式链接到单个文件 语法突出显示。
  • 使用标记来键入集合文档。
  • 软件相关部分之间的链接。
  • 引导文档的css,使其既可用又 很漂亮。
  • 可配置设置。
  • 能够创建包含一般信息的分层页面集, 与源代码的任何特定部分都没有关联。
  • 使用文件级文档显示非Fortran源文件的条目 以及语法突出显示的代码。

安装

安装福特最简单的方法是 pip。这可以用 命令

sudo pip install ford

pip将自动为您处理所有依赖项。如果你没有 对要生成的计算机具有管理权限 文档,pip将允许您安装ford及其依赖项 在一个位于 在你家里的某个地方。

如果愿意,可以手动安装所有这些依赖项并克隆 吉特胡布的福特。然后把福特放在你的Python身上。

或者,福特也可以通过Homebrew包购买 用于Mac OS X的管理器。若要更新自制程序并安装Ford,请在中运行以下命令 终端:

brew update
brew install FORD

如果您想从github安装最新的开发(master)分支, 只需添加--HEAD标志:brew install --HEAD FORD

文档

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

许可证

此程序是免费软件:您可以重新分发和/或修改 根据由 自由软件基金会,或者许可证的第3版,或者 (由您选择)任何更高版本。

这个程序的发布是希望它能有用, 但是没有任何保证;甚至没有 适销性适合特定用途。见 克nu通用公共许可证了解更多详细信息。

你应该收到GNU通用公共许可证的副本 还有这个节目。如果没有,请参阅GNU website

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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java根据选择随机设置图标   java如何将Android Studio与本地服务器数据库SQL server 2008连接?   java在点击鼠标后绘制一个椭圆形   java选项窗格相对于其父项的位置   java如何在Android中的switch case中使用String[]输入?   安卓无法从“15.0.1”确定java版本   如果满足特定条件,java是否重置计时器?   java是一个实体类,可以在OOAD中返回其他实体实例吗?   bash将对jar文件| cut | awk和java程序的调用集成到一个统一进程中   Spring安全更新身份验证成功时的最后登录日期   数据库身份验证中基于Java控制台的客户端服务器登录应用程序错误   java Selenium junit测试失败,驱动程序过早获取URL   java LibGdx多点触摸事件混淆   带扫描仪的java打印空间   来自旧版应用程序的java springcloudsleuth头   java如何实现模板设计模式?   java如何比较具有多个值的键的两个映射?   读取时R中的java MemoryError。xlsx