Fortran 样式指南#

命名约定#

最终,这取决于个人偏好。以下是一个我们喜欢的并且在大多数科学代码(以及 Fortran 标准库)中普遍使用的样式指南,欢迎您遵循它。

  1. 对于所有 Fortran 结构(dosubroutinemodule 等)使用小写。

  2. 对于数学变量/函数,遵循简短的数学符号(YlmGammagammaEnlRnl 等)。

  3. 对于其他名称,全部使用小写:尽量将名称限制在一到两个音节;如果需要更多音节,请使用下划线来澄清(sortpairwhitecharmeshexpnumstringslinspacemeshgridargsortsplinespline_interpspline_interpolatestoperrstop_errormeshexp_der)。

例如,“spline interpolation”可以缩短为 spline_interpolationspline_interpolatespline_interpspline,但不能缩短为 splineint(“int”可能表示积分、整数等——即使在计算代码的清晰上下文中,也存在太多歧义)。这与 get_argument() 形成对比,在 getarg() 中,完全清晰简洁。

以上是一些通用指南。一般来说,选择合适的名称确实取决于被截断的单词,以及第一个音节是否足够。通常情况下是足够的,但显然并非总是如此。因此,在“尽量将名称限制在 2 个音节或更少”这一步骤中,应该进行一些思考,因为它确实会影响指示性和简洁性。简单一致的命名规则在这方面确实很有帮助——无论是在协作方面还是在回顾一段时间未曾接触过的旧代码时保持自身清醒方面。

缩进#

使用一致的缩进使您的代码易于阅读。缩进量取决于个人偏好,最常见的选项是两个、三个或四个空格。

与其他语言的比较#

另一方面,在编程世界的其他大部分领域,主要关注点是以某种形式定义和使用大量复杂的物体,这些物体具有大量的属性和行为,仅在定义它们的代码中已知(而不是在整个文献中由相同的符号定义),使用更长、更具描述性的名称更有意义。因此,在 C++ 和 Python 等更通用的语言中看到的命名约定与其更通用的使命完全一致。但 Fortran 的使命不同(数值科学计算)。