Byłem ciekawy, czy ktoś wiedział o rekomendacji z renomowanego źródła dla maksymalnej liczby linii kodu dla danego pliku. Na przykład Google Closure Linter zaleca, aby każda linia nie przekraczała 80 znaków.
coding-style
Devin G. Rhode
źródło
źródło
Odpowiedzi:
Plik powinien być na tyle krótki, aby można było znaleźć dowolną funkcję lub metodę bez wielokrotnego przewijania w tę iz powrotem, szukania go lub konieczności pamiętania szukanego ciągu. Metryka, której używam, to ilość czasu spędzonego na poszukiwaniu kodu w pliku w porównaniu do jego odczytu. Jeśli stanie się to zauważalne, czas ponownie podzielić plik lub klasę.
Dobry rozmiar podstawowego bloku kodu jest wystarczająco krótki, zarówno pod względem szerokości, jak i wysokości, aby można było wyświetlić jego wnętrzności podczas przeglądu kodu grupowego i dopasować go do siebie tak, aby czcionka nie była tak mała, że facet z tyłu sala konferencyjna nie może tego odczytać. Rozmiar ten pomaga również, jeśli kiedykolwiek zostaniesz wezwany do wyjaśnienia jakiegoś kodu, gdy wszystko co masz przy sobie to urządzenie mobilne lub tablet.
źródło
Nie ma czegoś takiego, a gdyby tak było, byłoby wysoce zależne od tego, jakiego języka używałeś (robiąc to samo w asemblerze w porównaniu do C # lub Java).
W przypadku języków wyższego poziomu możesz zobaczyć tę dyskusję SO. W przypadku języka Java / C # Bob Martin zaleca maksymalnie 10-20 wierszy na metodę . Nie ma dyskusji na temat plików, ponieważ nie jest to istotne i zależy od tego, co klasa ma zrobić.
W odniesieniu do limitu 80 znaków na linię - jest to powrót do dni kart dziurkacza. Powiedziawszy to, gdy linie rosną zbyt długo, zmniejsza się czytelność.
źródło
Długości pliku i linii są pomiarami wtórnych efektów złożoności i jako takie są bardzo zmienne. Powinieneś dążyć do kodu bez niepotrzebnej złożoności, a nie określonej maksymalnej liczby wierszy.
Długie pliki zwykle wskazują, że metody, podprogramy lub klasy są zbyt skomplikowane (wykonywanie zbyt wielu czynności, niewystarczające uwzględnienie itp.)
Długie linie zwykle wskazują, że wyrażenia są zbyt złożone.
Są to zapachy, które wskazują na potencjalny problem z kodem, nie są dobrze zdefiniowanymi docelowymi wskaźnikami.
źródło
Długość linii powinna być taka, aby nie trzeba było przewijać ekranu, aby zobaczyć całą linię. To zależy od wielkości monitora i rozdzielczości.
Metody i funkcje są najlepsze, jeśli można zmieścić jeden ekran.
Pliki nie powinny być za długie. Najlepsze są krótkie pliki, w których łatwo jest zrozumieć klasę i implementację.
Kiedyś pracowałem nad projektem, który miał plik 10 klines. To było jak czytanie bardzo złożonej książki. Czy muszę powiedzieć, ile problemów spowodowało wdrożenie?
źródło
80 znaków!
Pamiętam, że kiedy robiłem COBOL, widziałem pliki kodu źródłowego dla programów rozliczeniowych około 80 stron i więcej. Oczywiście nie widzę, że jest to prawie powszechna praktyka, ale 80 znaków jest równie niedorzeczne.
Z widoku wielkości klasy, jeśli spróbujesz zastosować tę sugestię do typowej klasy klienta, która ma około 80 właściwości i około 20 metod, będziesz musiał podzielić klasę na kilka innych i sprawić, że kod będzie naprawdę bardzo nieporządny.
źródło
Staram się, aby klasy i metody były krótkie, ale nie martwię się o długość linii. W dzisiejszych czasach szerokich ekranów i długich identyfikatorów uważam, że osiemdziesiąt znaków to zdecydowanie za mało. Złamanie instrukcji zajmuje trochę pracy, aby można je było łatwo odczytać, a przy limicie osiemdziesięciu znaków zdarza się to dość często. Myślę, że około 120 lub 130 kolumn w wierszu jest bardziej rozsądne.
źródło