Fortranスタイルガイド#
命名規則#
最終的には好みの問題です。 多くの科学コード(およびFortran標準ライブラリ)で広く使用されている、私たちが好むスタイルガイドを以下に示します。ご自由に従ってください。
すべてのFortran構成要素(
do
、subroutine
、module
など)には小文字を使用します。数学変数/関数には短い数学表記に従います(
Ylm
、Gamma
、gamma
、Enl
、Rnl
など)。その他の名前にはすべて小文字を使用します。 名前は1つか2つの音節に保つようにしてください。 もっと必要な場合は、アンダースコアを使用して明確にします(
sortpair
、whitechar
、meshexp
、numstrings
、linspace
、meshgrid
、argsort
、spline
、spline_interp
、spline_interpolate
、stoperr
、stop_error
、meshexp_der
)。
たとえば、「スプライン補間」はspline_interpolation
、spline_interpolate
、spline_interp
、spline
に短縮できますが、splineint
には短縮できません(「int」は積分、整数などを意味する可能性があり、計算コードの明確なコンテキストであってもあいまいさが大きすぎます)。これは、get_argument()
とは対照的です。getarg()
は完全に明確で簡潔です。
上記は一般的なガイドラインです。 一般的に、適切な名前を選択することは、最初の音節で十分かどうかを判断するために切り詰められる単語に依存します。通常は十分ですが、明らかに常にそうとは限りません。 したがって、「名前を2音節以下にする」というステップには、いくつかの考慮が必要です。これは、指示性とシンプルさに大きく影響する可能性があるためです。 シンプルで一貫性のある命名規則は、共同作業と、しばらく見ていない古いコードに戻るときの自分の精神衛生の両方の点で、本当に役立ちます。
インデント#
コードの可読性を高めるために、一貫したインデントを使用します。 インデントの量は好みの問題です。最も一般的な選択肢は、2、3、または4スペースです。
他の言語との比較#
一方、プログラミングの世界の大部分では、主な焦点は、何らかの形で、多くのプロパティと動作を持つ複雑なオブジェクトの大規模なセットを定義および使用することにあり、それらは定義されているコードでのみ知られています(文献全体で同じ表記によって定義されるのではなく)。そのため、より長く、より記述的な名前を使用する方が理にかなっています。したがって、C++やPythonなどのより汎用的な言語で使用されている命名規則は、それらのより汎用的なミッションと完全に一致しています。しかし、Fortranには異なるミッション(数値科学計算)があります。