Używam Eclipse i porozmawiam o tym jako przykład, ale jestem pewien, że tak jest w każdym innym IDE.
Eclipse ma polecenie CTRL- Shift-, Fktóre automatycznie formatuje kod. Czy dobrą praktyką jest stosowanie tego rodzaju formatowania? Pytam w kontekście dużego projektu, w którym może być wielu programistów pracujących na tych samych plikach i wszystkie te są administrowane przez system CSV.
Dziękuję Ci!
Odpowiedzi:
Tak to jest.
Eclipse pozwala zdefiniować własny styl kodu do eksportu, który możesz udostępnić wszystkim programistom. Jeśli nie chcesz konfigurować własnego stylu formatowania, możesz poprosić programistów o użycie domyślnego formatowania Eclipse. Nawet jeśli używasz domyślnego, radzę go wyeksportować i umieścić na udostępnionym dysku sieciowym, z którego mogą korzystać wszyscy programiści. Jeśli później zdecydujesz się zmienić jedną rzecz, będziesz mógł to łatwo zrobić.
Niezależnie od tego radziłbym, abyś zaczął jak najszybciej, najlepiej na początku projektu i aby twój kod był zawsze sformatowany do wybranego przez ciebie formatu. Będziesz unikać unikania czystych „zatwierdzeń formatu” podczas programowania, ponieważ trudno jest odróżnić się od „prawdziwych” zatwierdzeń. W praktyce oznacza to, że programiści powinni rygorystycznie przestrzegać swoich zobowiązań .
Ponadto umieszczam to na końcu, ponieważ jest to tylko moja osobista opinia, ale rozważ usunięcie limitu 80 znaków na linię (lub rozszerzenie go na coś większego, mamy tutaj 120 znaków), co oznacza, że jeśli się nie mylę domyślna automatyczna formatowanie długości linii w Eclipse. Wszyscy mamy teraz duże ekrany i rozdzielczości dużego ekranu, więc jest w porządku. W tym temacie sprawdź, czy limit 80 znaków jest nadal istotny w czasach pytań i odpowiedzi monitorów panoramicznych , być może będziesz w stanie podjąć własną decyzję.
Edycja: Thorbjørn ma rację na temat funkcji „Formatuj za każdym razem, gdy plik jest zapisywany”.
Tak, to bardzo dobra praktyka. Zapewnia to, że wszyscy zgadzają się, jak powinny wyglądać pliki źródłowe podczas otwierania w edytorze.
Dodatkowo miałem bardzo dobre doświadczenia z funkcją „Formatuj za każdym razem, gdy plik jest zapisywany”. (Używamy standardowej konfiguracji formatyzatora Eclipse).
Włącz go, otwierając właściwości Eclipse i wybierz Java -> Edytor -> Zapisz akcje. Włącz „Wykonaj wybrane działania podczas zapisywania” i „Formatuj kod źródłowy”.
Powodem jest oczywiście to, że kod jest zawsze formatowany, więc możesz go dowolnie formatować podczas edycji bez obawy, że coś się zepsuje. Zapewnia to również, że dzienniki źródłowego repozytorium są dokładne (co jest ważne przy analizie sądowej).
Powinieneś mieć standard kodowania, którego wszyscy przestrzegacie. To, czy jest to wymuszane przez zewnętrzne narzędzia (takie jak wcięcie), IDE, czy ręcznie, jest w pewnym sensie nieistotne. Istotne jest to, że należy to zrobić przed zatwierdzeniem.
Dobrą praktyką jest przestrzeganie dobrze zdefiniowanego standardu kodowania w projekcie / firmie. Sposoby na zrobienie tego mogą się jednak różnić, po prostu wybierz to, co najlepiej pasuje do Twojej organizacji. Jeśli wszyscy używają Eclipse, możesz po prostu utworzyć format kodu do eksportu dla swoich projektów i rozdzielić go między programistów (Eclipse ma również opcję automatycznego formatowania plików przy każdym zapisie), ale zaleciłbym utworzenie dokumentu opisującego wybrany format.