Przewodnik stylu Fortran#
Nazewnictwo#
Koniec końców, jest to kwestia preferencji. Oto poradnik stylu, który nam się podoba i wydaje się być powszechny w większości kodów naukowych (jak również standardowej bibliotece Fortran), dlatego ty również możesz go stosować.
Używaj małych liter do wszystkich konstruktów Fortran (
do,subroutine,module, …).Stosuj krótką notację matematyczną dla zmiennych/funkcji matematycznych (
Ylm,Gamma,gamma,Enl,Rnl, …).Dla innych nazw używaj wyłącznie małych liter: postaraj się ograniczać do jednej lub dwóch sylab; jeśli wymagana jest dłuższa nazwa używaj podkreślników dla lepszego wyjaśnienia (
sortpair,whitechar,meshexp,numstrings,linspace,meshgrid,argsort,spline,spline_interp,spline_interpolate,stoperr,stop_error,meshexp_der).
Na przykład fraza „spline inerpolation” może być skrócona do spline_interpolation, spline_interpolate, spline_interp, spline, ale nie do splineint („int” może oznaczać integration (integrację), integer (liczbę całkowitą) itd. — zbyt duża niejednoznaczność nawet w zrozumiałym kontekście kodu obliczeniowego). Dla porówniania getarg() jest prostym i zrozumiałym skrótem frazy get_argument().
Powyższe zasady są generalnymi wytycznymi. Wybór odpowiedniej nazwy zależy od słów, które mają być skrócone i tego czy pierwsza sylaba będzie wystarczająca. Zazwyczaj jest, jednak nie zawsze. Powinniśmy się również zastanowić nad krokiem „postaraj się ograniczać do jednej lub dwóch sylab”, ponieważ może to mieć wpływ na zrozumiałość i prostotę kodu. Jasny i jednolity system nazewnictwa jest w tym przypadku pomocny – zarówno dla współpracy oraz własnego zdrowia psychicznego podczas wracania do starego kodu, którego nie widziało się przez jakiś czas.
Wcięcia#
Używaj stałych wcięć, aby twój kod był bardziej czytelny. Ilość wcięć jest kwestią preferencji, najbardziej powszechnym wyborem są dwie, trzy lub cztery odstępy.
Porównanie z innymi językami#
Z drugiej strony, w większości innych środowisk programistycznych, gdzie głównym celem jest (w takiej lub innej formie) definiowanie i używanie dużych zestawów złożonych obiektów z mnóstwem właściwości i zachowań znanych tylko w kodzie, w którym są zdefiniowane (w przeciwieństwie do zdefiniowanych tą samą notacją w całej literaturze), większy sens ma używanie dłuższych, bardziej opisowych nazw. Konwencje nazewnictwa, które można zauważyć w bardziej ogólnych językach takich jak C++ oraz Python są zatem całkowicie spójne z ich celem. Fortran jednak stworzony został w innym celu (numeryczne obliczenia naukowe).