F#-Styleguide

In den folgenden Artikeln werden Richtlinien für die Formatierung von F#-Code und aktuelle Anleitungen für Features der Sprache und deren Verwendung beschrieben.

Dieser Leitfaden wurde basierend auf der Verwendung von F# in großen Codebasen mit einer vielzahl Von Programmierern formuliert. Diese Anleitung führt in der Regel zu einer erfolgreichen Verwendung von F# und minimiert Frustrationen, wenn sich die Anforderungen für Programme im Laufe der Zeit ändern.

Fünf Prinzipien des guten F#-Codes

Beachten Sie die folgenden Prinzipien, wenn Sie F#-Code schreiben, insbesondere in Systemen, die sich im Laufe der Zeit ändern. Jeder Leitfaden in weiteren Artikeln stammt aus diesen fünf Punkten.

1. Guter F#-Code ist prägnant, ausdrucksstark und komponierbar

   F# verfügt über viele Features, mit denen Sie Aktionen in weniger Codezeilen ausdrücken und generische Funktionen wiederverwenden können. Die F#-Kernbibliothek enthält auch viele nützliche Typen und Funktionen zum Arbeiten mit gemeinsamen Sammlungen von Daten. Die Zusammenstellung Ihrer eigenen Funktionen und der Funktionen in der F#-Kernbibliothek (oder anderen Bibliotheken) ist Teil der routinemäßigen idiomatischen F#-Programmierung. In der Regel, wenn Sie eine Lösung für ein Problem in weniger Codezeilen ausdrücken können, werden andere Entwickler (oder Ihr zukünftiges Selbst) wertschätzend sein. Es wird auch dringend empfohlen, eine Bibliothek wie FSharp.Core, die großen .NET-Bibliotheken , auf denen F# ausgeführt wird, oder ein Drittanbieterpaket auf NuGet zu verwenden, wenn Sie eine nichttriviale Aufgabe ausführen müssen.

2. Guter F#-Code ist interoperabel

   Die Interoperabilität kann mehrere Formen annehmen, einschließlich der Verwendung von Code in verschiedenen Sprachen. Die Schnittstellen Ihres Codes, mit denen andere Aufrufer interagieren, sind entscheidende Elemente, die korrekt gestaltet werden müssen, auch wenn die Aufrufer ebenfalls in F# geschrieben sind. Beim Schreiben von F# sollten Sie immer darüber nachdenken, wie anderer Code den Code aufruft, den Sie schreiben, einschließlich, wenn dies in einer anderen Sprache wie C# geschieht. Die F#-Komponentenentwurfsrichtlinien beschreiben die Interoperabilität im Detail.

3. Guter F#-Code verwendet die Objektprogrammierung, nicht die Objektausrichtung.

   F# unterstützt die vollständige Programmierung mit Objekten in .NET, einschließlich Klassen, Schnittstellen, Zugriffsmodifizierern, abstrakten Klassen usw. Für komplizierteren funktionalen Code, z. B. Funktionen, die im Kontext verwendet werden müssen, können Objekte kontextbezogene Informationen auf einfache Weise kapseln, auf eine Weise, die Funktionen nicht können. Features wie optionale Parameter und der sorgfältige Einsatz von Überladungen können die Nutzung dieser Funktionalität für Aufrufer vereinfachen.

4. Guter F#-Code erzielt eine gute Leistung, ohne Mutation verfügbar zu machen

   Es ist kein Geheimnis, dass man, um leistungsstarken Code zu schreiben, Mutation verwenden muss. Es ist, wie Computer funktionieren, schließlich. Ein solcher Code ist häufig fehleranfällig und schwer richtig zu machen. Vermeiden Sie das Exponieren von Mutationen für Anrufer. Erstellen Sie stattdessen eine funktionale Schnittstelle, die eine mutationsbasierte Implementierung ausblendet, wenn die Leistung kritisch ist.

5. Guter F#-Code ist toolierbar

   Tools sind für die Arbeit in großen Codebasen unschätzbar, und Sie können F#-Code schreiben, sodass sie mit F#-Sprachtools effektiver verwendet werden kann. Beispielsweise sollten Sie möglichst keinen punktfreien Programmierstil verfolgen, damit Zwischenwerte mit dem Debugger überprüft werden können. Ein weiteres Beispiel ist die Verwendung XML-Dokumentationskommentaren zur Beschreibung von Konstrukten, sodass diese Kommentare in Editoren am Aufrufort als QuickInfos angezeigt werden können. Denken Sie immer darüber nach, wie Ihr Code mit ihren Tools gelesen, navigiert, gedebuggt und von anderen Programmierern bearbeitet wird.

Nächste Schritte

Die F#-Codeformatierungsrichtlinien enthalten Anleitungen zum Formatieren von Code, sodass sie leicht zu lesen sind.

Die F#-Codierungskonventionen bieten Anleitungen für F#-Programmier-Idiome, die die langfristige Wartung größerer F#-Codebasen unterstützen.

Die F#-Komponentenentwurfsrichtlinien bieten Anleitungen für die Erstellung von F#-Komponenten, z. B. Bibliotheken.