fprettify 项目教程

fprettify 项目教程

fprettify auto-formatter for modern fortran source code 项目地址: https://gitcode.com/gh_mirrors/fp/fprettify

1. 项目的目录结构及介绍

fprettify 是一个用于现代 Fortran 代码的自动格式化工具。以下是该项目的目录结构及其介绍：

fprettify/
├── examples/
│   ├── before/
│   └── after/
├── fortran_tests/
│   ├── before/
│   └── after/
├── fprettify/
│   ├── __init__.py
│   └── fprettify.py
├── .gitignore
├── .pre-commit-hooks.yaml
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.md
├── environment.yml
├── fprettify.py
├── hooks.yml
├── pyproject.toml
├── requirements.txt
├── run_tests.py
├── setup.cfg
└── setup.py

目录结构介绍

• examples/: 包含格式化前后的 Fortran 代码示例。

  • before/: 格式化前的 Fortran 代码。
  • after/: 格式化后的 Fortran 代码。

• fortran_tests/: 用于测试 fprettify 的 Fortran 代码。

  • before/: 测试前的 Fortran 代码。
  • after/: 测试后的 Fortran 代码。

• fprettify/: fprettify 的核心代码目录。

  • init.py: 初始化文件。
  • fprettify.py: 主要格式化逻辑的 Python 文件。

• .gitignore: Git 忽略文件配置。

• .pre-commit-hooks.yaml: 预提交钩子配置文件。

• .travis.yml: Travis CI 配置文件。

• LICENSE: 项目许可证。

• MANIFEST.in: 打包清单文件。

• README.md: 项目介绍和使用说明。

• environment.yml: Conda 环境配置文件。

• fprettify.py: 主要格式化逻辑的 Python 文件。

• hooks.yml: 钩子配置文件。

• pyproject.toml: Python 项目配置文件。

• requirements.txt: 项目依赖文件。

• run_tests.py: 测试运行脚本。

• setup.cfg: 安装配置文件。

• setup.py: 安装脚本。

2. 项目的启动文件介绍

fprettify 的启动文件是 fprettify.py。该文件包含了 fprettify 的核心逻辑，用于自动格式化 Fortran 代码。

启动文件介绍

• fprettify.py: 这是 fprettify 的主要启动文件。它包含了格式化 Fortran 代码的逻辑，可以通过命令行调用该文件来格式化指定的 Fortran 文件。

3. 项目的配置文件介绍

fprettify 的配置文件主要包括 setup.cfg 和 pyproject.toml。

配置文件介绍

• setup.cfg: 该文件包含了 fprettify 的安装配置信息，如包的元数据、依赖项等。
• pyproject.toml: 该文件是 Python 项目的配置文件，定义了项目的构建系统和依赖项。

通过这些配置文件，用户可以自定义 fprettify 的行为，例如设置缩进大小、启用或禁用某些功能等。

---

以上是 fprettify 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 fprettify。

fprettify auto-formatter for modern fortran source code 项目地址: https://gitcode.com/gh_mirrors/fp/fprettify