Ich verwende Eclipse und werde als Beispiel darüber sprechen, aber ich bin sicher, dass dies bei jeder anderen IDE der Fall ist.
Eclipse verfügt über den Befehl CTRL- Shift-, Fder Ihren Code automatisch formatiert. Ist es eine gute Praxis, diese Art der Formatierung zu verwenden? Ich frage im Zusammenhang mit einem großen Projekt, in dem möglicherweise viele Programmierer an denselben Dateien arbeiten und alle diese von einem CSV-System verwaltet werden.
Vielen Dank!
Antworten:
Ja ist es.
Mit Eclipse können Sie Ihren eigenen exportierbaren Codestil definieren, den Sie für alle Ihre Entwickler freigeben können. Wenn Sie keinen eigenen Formatierungsstil einrichten möchten, können Sie Ihre Entwickler anweisen, die Standardformatierung von Eclipse zu verwenden. Selbst wenn Sie die Standardeinstellung verwenden, würde ich Ihnen raten, sie zu exportieren und auf einem freigegebenen Netzlaufwerk abzulegen, damit alle Entwickler sie verwenden können. Wenn Sie sich später dazu entschließen, eine Sache zu ändern, können Sie dies problemlos tun.
Unabhängig davon würde ich Ihnen raten, so schnell wie möglich zu beginnen, am besten zu Beginn des Projekts, und Ihren Code immer in dem von Ihnen gewählten Format zu formatieren. Sie sollten vermeiden, während der Entwicklung reine "Format-Commits" zu haben, da es dann schwierig ist, von "echten" Commits zu unterscheiden. In der Praxis bedeutet dies, dass Entwickler ihre Commits streng einhalten sollten .
Außerdem, und ich setze es am Ende, weil es nur meine persönliche Meinung ist, aber erwägen Sie, das Limit von 80 Zeichen pro Zeile zu entfernen (oder es auf etwas Größeres zu erweitern, wir haben hier 120 Zeichen), was bedeutet, wenn ich mich nicht irre Standardmäßige automatische Formatierung der Zeilenlänge in Eclipse. Wir haben jetzt alle große Bildschirme und große Bildschirmauflösungen, also ist es in Ordnung. Überprüfen Sie zu diesem Thema die Frage: Ist die Beschränkung auf 80 Zeichen in Zeiten von Fragen und Antworten auf Breitbildmonitore immer noch relevant? Dann können Sie möglicherweise Ihre eigene Entscheidung treffen.
Bearbeiten: Thorbjørn macht einen guten Punkt über die Funktion "Jedes Mal formatieren, wenn eine Datei gespeichert wird".
Ja, es ist eine sehr gute Praxis. Es stellt sicher, dass alle zustimmen, wie Quelldateien aussehen sollen , wenn sie in einem Editor geöffnet werden.
Darüber hinaus habe ich sehr gute Erfahrungen mit der Funktion "Jedes Mal formatieren, wenn eine Datei gespeichert wird" gemacht. (Wir verwenden die Standardkonfiguration des Eclipse-Formatierers).
Aktivieren Sie es, indem Sie die Eclipse-Eigenschaften öffnen und Java -> Editor -> Aktionen speichern auswählen. Aktivieren Sie "Ausführen der ausgewählten Aktionen beim Speichern" und "Quellcode formatieren".
Der Grund ist natürlich, dass der Code immer formatiert ist, sodass Sie ihn beim Bearbeiten nach Belieben formatieren können, ohne befürchten zu müssen, dass etwas kaputt geht. Dies stellt auch sicher, dass die Quell-Repository-Protokolle korrekt sind (was bei forensischen Analysen wichtig ist).
Sie sollten einen Codierungsstandard haben, dem Sie alle folgen. Ob dies durch externe Tools (z. B. Einzug), IDE oder von Hand erzwungen wird, spielt keine Rolle. Relevant ist, dass dies vor dem Festschreiben erfolgen sollte.
Es ist eine gute Praxis, in einem Projekt / Unternehmen einen genau definierten Codierungsstandard zu befolgen. Die Möglichkeiten hierfür können jedoch variieren. Wählen Sie einfach das aus, was für Ihr Unternehmen am besten geeignet ist. Wenn jeder Eclipse verwendet, können Sie einfach ein exportierbares Codeformat für Ihre Projekte erstellen und es unter den Entwicklern verteilen (Eclipse bietet auch die Möglichkeit, Dateien bei jedem Speichern automatisch zu formatieren). Ich würde jedoch empfehlen, ein Dokument zu erstellen, das das ausgewählte Format beschreibt.