Co to znaczy napisać " dobry kod "? [zamknięte]

Komentarze

Dobry kod jest, jeśli spojrzysz na niego po dwóch latach, a Twoja pierwsza myśl to nie ' t " Koleś, wtf ".
duplikat Skąd wiesz, czy ' napisałeś jako czytelny i łatwy w utrzymaniu kod?

Odpowiedź

Dobry programista jest jak dobry gracz w bilard.

Kiedy zobaczysz profesjonalnego gracza w bilard, na początku możesz nie być pod wrażeniem: „Jasne, wbili wszystkie piłki, ale oddali tylko łatwe uderzenia!” Dzieje się tak dlatego, że kiedy gracz w bilard oddaje strzał, nie myśli o tym, jaka bila trafi do której kieszeni, myśli również o tym, gdzie skończy się biała bila . Przygotowanie do kolejnego ujęcia wymaga ogromnych umiejętności i praktyki, ale oznacza również, że wygląda na łatwe.

Teraz, przenosząc tę metaforę do kodu, coder pisze kod, który wygląda tak, jakby było łatwe i proste do zrobienia . Wiele przykładów Briana Kernighana w jego książkach jest zgodnych z tym wzorem. Częścią „sztuczki” jest wymyślenie właściwej konceptualizacji problemu i jego rozwiązania . Kiedy nie rozumiemy wystarczająco dobrze problemu, istnieje większe prawdopodobieństwo, że nadmiernie skomplikujemy nasze rozwiązania i nie uda nam się znaleźć jednoczących pomysłów.

Przy odpowiedniej konceptualizacji problemu otrzymujesz wszystko inaczej: czytelność, łatwość konserwacji, wydajność i poprawność. Ponieważ rozwiązanie wydaje się tak proste, prawdopodobnie będzie mniej komentarzy, ponieważ dodatkowe wyjaśnienia są niepotrzebne. Dobry programista może również zapoznać się z długoterminową wizją produktu i odpowiednio sformułować konceptualizację.

Komentarze

" dobry programista pisze kod, który wygląda tak, jakby był łatwy i prosty do wykonania. " < < DOKŁADNIE! Myślę, że dzieje się tak, ponieważ ludzie zazwyczaj myślą, że dobry programista to ktoś, kto potrafi pisać bardzo " sprytne " hacki. Jeśli kod jest czysty i nie przesadnie " sprytny ", to musi być łatwe, prawda?
Moja 2 centów: kiedy ' masz język z EASY automatycznymi refaktoryzacjami – Java i C # to dwa przykłady, które znam najlepiej – to ' łatwo jest iteracyjnie przejść do dobrego kodu. W przeciwnym razie musisz przede wszystkim dobrze konceptualizować, ale istnieje pewien rodzaj problemu z jajkiem kurzego.
Niektóre algorytmy są z natury złożone. Dobry programista nie powinien mieć problemu z napisaniem ich, gdy są naprawdę potrzebne – i utrzymaniem ich w jak największej czytelności.
@hasenj: tak, to z powodu tego lematu: głupi ludzie piszą kod zrozumiały dla kompilatora. Sprytni ludzie piszą kod, który głupi ludzie rozumieją.

Odpowiedź

WTF

s na minutę

( oryginał )

EDYCJA: Podstawową ideą jest to, że „Jakości kodu” nie można umieścić w regułach, w ten sam sposób, w jaki nie można umieścić w regułach „Dobrej sztuki” lub „Dobrej poezji”, tak aby komputer zdecydował, że powie „Tak, dobra sztuka ”lub„ Nie, zła poezja ”. Obecnie jedynym sposobem jest zobaczenie, jak łatwo zrozumiały jest kod dla innych ludzi.

Komentarze

Utknęliśmy na naszej tablicy w pracy: -)
@Cape Cod Gunny był w książce wuja Boba '
Oprócz bycia świetną kreskówką myślę, że naprawdę do rzeczy – dobry kod to taki, który inni ludzie uważają za przyjemny do czytania i utrzymywania.
Tak więc, dobry kod to każdy kod, który nie jest zły. Np. Trudno jest zdefiniować dobry kod, łatwiej jest zdefiniować zły kod.
Zwykle znajduję te " WTF? " ' po spotkaniu dotyczącym dobrego kodu następuje wkrótce " Oooooh OK … Widzę, co zrobiłeś."

Odpowiedź

Tak naprawdę nie ma innych dobrych kryteriów niż szybkość rozumienia kodu. Aby Twój kod wyglądał dobrze, znajdując idealny kompromis między zwięzłością a czytelnością.

„WTF” na minutę (powyżej) jest prawdą, ale jest to tylko następstwo bardziej ogólnej zasady. Im więcej WTF, tym wolniejsze zrozumienie.

Komentarze

@rmx: define " wykonując zadanie no cóż "
Cóż, metoda RemoveCustomer faktycznie usuwa cutomer bez zepsucia. Możesz spędzać godziny, aby wyglądać ładnie, ale to nie znaczy, że faktycznie działa. ' Jak szybko rozumiesz kod ' to nie jedyne kryterium ' dobrego kodu ' jest tym, co ' mówię.
@rmx: ale brak błędów jest implikowany, nie ' czy to? Jeśli Twój kod nie ' nie wykonuje zadania poprawnie, ' nie koduje (jeszcze).
@ rmx: w rzeczywistości nie. Jeśli kod jest łatwy do zrozumienia, podsumowując, ' jest łatwy do zrozumienia, jeśli robi to ' źle. OTOH, jeśli ' jest trudne do zrozumienia, ' jest trudne do zrozumienia, jeśli tak jest ' w ogóle.
@rmx: PS Mówiąc prościej, dekrementacja () jest klasycznym WTF i dlatego spowalnia zrozumienie części kodu, w których ta funkcja jest używana.

Odpowiedź

Wiesz, że piszesz dobry kod, gdy …

Klient jest zadowolony
Koledzy pożyczają Twój kod jako punkt wyjścia
Całkiem nowemu facetowi / dziewczynie powiedziano właśnie, aby wprowadził modyfikacje do systemu, który zbudowałeś 6 miesięcy temu i ani razu nie zadał Ci pytania
Twój szef prosi Cię o opracowanie nowych widżetów zespół do użycia
Patrzysz na kod, który piszesz dzisiaj i mówisz sobie „Szkoda, że nie napisałem takiego kodu dwa lata temu”

Jak się masz zmierzyć, czy kod jest dobry …

Jaki jest czas odpowiedzi?
Ile podróży w obie strony do serwera wykonuje?
Czy użyłbyś aplikacji osobiście, czy uważasz, że jest niezgrabna?
Czy następnym razem zbudowałbyś ją w ten sam sposób?

Dobry kod działa, gdy jest powinien. Dobry kod można łatwo zmodyfikować, gdy zajdzie taka potrzeba. Dobry kod można ponownie wykorzystać w celu osiągnięcia zysku.

Komentarze

" Klient jest zadowolony " jest do tego ortogonalne.
@TRA – Jeśli klient jest zadowolony, oznacza to, że zrozumiałeś wymagania i zapewniłeś rozwiązanie, którego oczekiwał.
oczywiście, ale zły kod może zrobić to samo.

Odpowiedź

Kod, który jest

bez błędów
wielokrotnego użytku
niezależny
mniej skomplikowane
dobrze udokumentowane
łatwe do zmiany

nazywa się dobrym kodem.

Dobry program działa bezbłędnie i nie ma żadnych błędów. Ale jakie cechy wewnętrzne dają taką doskonałość? To żadna tajemnica, potrzebujemy tylko od czasu do czasu przypomnienia. Niezależnie od tego, czy programujesz w językach C / C ++, C #, Java, Basic, Perl, COBOL czy ASM, wszystkie dobre programy programistyczne wykazują te same cechy, które są uświęcone przez długi czas: prostotę, czytelność, modułowość , warstwowość, projekt, wydajność, elegancja i przejrzystość wydajność, elegancja i przejrzystość

Źródło: MSDN

Komentarze

Prostota, czytelność, elegancja i przejrzystość to to samo. Modułowość i warstwowanie to tylko metody na uczynienie kodu przejrzystym i eleganckie. Jedyną rzeczą, która pozostała na liście jest wydajność, co jest trochę implikowane, a poza tym często jest to kwestia kompromisu między wydajnością a przejrzystością.
Sprawdź to: goo.gl/hdQt8
Kod może być wolny od błędów?
Nie, nie może ' t. (Praktycznie)
Wydajny powinien zostać dodany do listy. Szybkość nie jest ' t konieczna jest to główny wskaźnik dobrego kodu, ale dobry kod nie powinien ' nie być niepotrzebnie powolny ani marnotrawny.

Odpowiedź

Czy to wydaje się znajome?

Firma Philips dała mi możliwość obejrzenia projektu nowego produktu. W miarę rozwoju stawałem się coraz bardziej niespokojny i zacząłem zwierzyć się ze swoich obaw przełożonemu. Wielokrotnie powtarzałem mu, że projekty nie są „czyste” i powinny być „piękne” w taki sam sposób, w jaki projekty Dijkstry były piękne. Nie uznał tego za przydatny komentarz.Przypomniał mi, że jesteśmy inżynierami, a nie artystami. W jego myślach po prostu wyrażałem swój gust, a on chciał wiedzieć, jakiego kryterium się posługuję przy dokonywaniu oceny. Nie mogłem mu powiedzieć! Ponieważ nie mogłem wyjaśnić, jakie zasady zostały naruszone, moje uwagi zostały po prostu zignorowane i praca trwała dalej. Wyczuwając, że musi istnieć sposób, aby wyjaśnić i zmotywować mój „gust”, zacząłem szukać zasady, która odróżni dobre projekty od złych. Inżynierowie są bardzo pragmatyczni; mogą podziwiać piękno, ale szukają użyteczności. Próbowałem znaleźć wyjaśnienie, dlaczego słowo „piękno” jest przydatne.

Pozostałe informacje znajdziesz tutaj .

Komentarze

Ponieważ link w poście @mlvljr ' jest uszkodzony , oto link do strony Książek Google: books.google.co.in/…
@balajeerc Dzięki (poprawiłem również link, więc wskazuje na wersję tego samego pliku PDF hostowaną przez Springer) 🙂

Odpowiedź

poza naturalnymi kryteriami jakości kodu (minimalne kopiowanie / wklejanie, brak spaghetti itp.) dobry kod przemysłowy powinien zawsze wyglądać nieco naiwnie, trochę zbyt rozwlekle, jak

int key = i; const bool do_not_create = false; Record r = cache.get(key, do_not_create); ++i;

w przeciwieństwie do

Record r = cache.get(i++, false);

Komentarze

Ale czy do_not_create = false oznacza „zalicz false jako argument do_not_create, tak aby zostanie utworzony ”lub„ pas s false jako argument do_create, aby nie został utworzony ”? W języku, w którym można używać nazw argumentów, wolałbym cache.get (key:i, create: false); i += 1;.

Odpowiedź

Być może pomocna byłaby odpowiedź poprzez zilustrowanie odwrotnej sytuacji (dodatkowo jest to wymówka, aby uzyskać tutaj XKCD ).

tekst alternatywny

Dobry kod jest

prosty do zrozumienia,
łatwy w utrzymaniu ,
nie próbuje rozwiązywać wszystkich problemów, tylko ten pod ręką
żyje przez długi czas bez zmuszania programistów do szukania alternatywy

Przykłady obejmują

Apache Commons
Spring framework
Hibernate framework

Odpowiedź

Po prostu przejdę do „utrzymywania”

Cały kod musi być utrzymywany: nie ma potrzeby, aby to zadanie było trudniejsze niż to konieczne

Jeśli jakikolwiek czytelnik nie rozumie tego prostego wymagania lub potrzebuje go opisanego, to nie powinien on pisać kodu …

Odpowiedź

Dobry kod będzie inny dla każdej osoby, a język, z którym pracują, również ma wpływ na to, co można rozważyć być dobrym kodem. Generalnie, kiedy podchodzę do projektu, szukam następujących rzeczy:

Jak jest zorganizowany projekt? Czy pliki źródłowe są uporządkowane w przejrzysty sposób i czy mogę znaleźć kod bez zbytniego wysiłku?
Jak zorganizowany jest kod? Czy jest jasno udokumentowane, co robi kod w pliku, na przykład poprzez użycie nagłówka pliku lub użycie każdej klasy znajdującej się w jej własnym pliku? Czy w pliku są funkcje, które nie są już używane w aplikacji?
Jak są zorganizowane funkcje? Czy istnieje wyraźny wzorzec określający, gdzie deklarowane są zmienne, czy też jest to dość losowy wzorzec? Czy kod ma logiczny przepływ i unika niepotrzebnych struktur kontrolnych? Czy wszystko jest jasno udokumentowane, a kod jest samodokumentujący się tam, gdzie jest to konieczne, a komentarze jasno określają, dlaczego i / lub jak robi to kod?

Poza tym wszystko, czy projekt aplikacja ma sens jako całość? Kod znajdujący się w aplikacji może być najlepszy na świecie, ale praca z nim może być uciążliwa, jeśli ogólny projekt aplikacji nie ma sensu.

Odpowiedź

Pozwólcie, że nie zgodzę się z czytelnością. Nie, nie do końca: dobry kod powinien być czytelny i można to łatwo osiągnąć przy wystarczającej liczbie komentarzy.

Ale rozważam dwa rodzaje WTF: te, w których zastanawiasz się, czy programista poszedł dalej niż programowanie 101, i te, w których absolutnie nie rozumiesz genialności kodu. Niektóre kody mogą wyglądać bardzo dziwnie po pierwsze, ale w rzeczywistości jest bardzo pomysłowym rozwiązaniem trudnego problemu. Drugi nie powinien się liczyć w mierniku WTF i można go uniknąć poprzez komentarze.

Bardzo czytelny kod może być bardzo, bardzo wolny . Mniej czytelne rozwiązanie może znacznie poprawić szybkość. R jest doskonałym przykładem języka, w którym często jest to prawdą. Lubi się tam unikać pętli for tak bardzo, jak to tylko możliwe.Ogólnie rzecz biorąc, uważam, że najszybszy kod jest lepszym kodem, mimo że jest mniej czytelny. To znaczy, jeśli poprawa jest znacząca poza kursem i wstawiono wystarczająco dużo komentarzy, aby wyjaśnić, co robi kod.

Co więcej, zarządzanie pamięcią może mieć kluczowe znaczenie w wielu zastosowaniach naukowych. Kod, który jest bardzo czytelny, jest raczej niechlujny w wykorzystaniu pamięci: powstaje po prostu więcej obiektów. W niektórych przypadkach sprytne wykorzystanie pamięci sprawia, że kod jest znowu mniej czytelny. Ale jeśli na przykład żonglujesz gigabajtami sekwencji DNA, pamięć jest kluczowym czynnikiem. Ponownie uważam, że kod zajmujący mniej pamięci jest lepszy, niezależnie od czytelności.

Tak, czytelność jest ważna dla dobrego kodu. Znam adagium Uwe Liggisa: myślenie boli, a komputery są tanie. Ale w mojej dziedzinie (genomika statystyczna) czasy obliczeniowe w tygodniu i użycie pamięci powyżej 40 GB nie są uważane za nieprawidłowe. Tak więc dwukrotne zwiększenie szybkości i zmniejszenie o połowę pamięci jest warte o wiele więcej niż dodatkowa czytelność.

Komentarze

Brak reguł / reguł bez wyjątku
Pozwól, że nie zgodzę się z twoim sprzeciwem: mówisz, że w twoim polu szybkość jest bardzo ważna i mówisz, że jest ważniejsza niż czytelność. Nie zgadzam się, powinieneś starać się zachować odpowiednią równowagę. Jeśli szybkość nie jest potrzebna, na przykład dla interfejsu wysokiego poziomu, możesz preferować coś łatwego w utrzymaniu, jeśli potrzebna jest szybkość, zgadzam się z tobą. Zamiast twardych reguł lepiej jest kierować się zdrowym rozsądkiem i i tak unikać przedwczesnej optymalizacji.
@BlueTrin Dlaczego nie skompilować mózgowo tych doskonałych kodezów źródłowych, a także udokumentować piekło, co ' dzieje się tam (w komentarzach)?

Odpowiedz

Jeśli chodzi o mnie… wiem, że piszę dobry kod, gdy przychodzi współpracownik, który pracuje nad innym projektem i jest w stanie wskoczyć i zrozumieć, co robię, bez konieczności przechodzenia przez każdy blok kodu i pokazując, co robi.
Zamiast mówić: „Chwileczkę, co ?!” Mówi: „O, ok, widzę, co tam zrobiłeś”.

Dobry kod nie ma też wielu podstępnych obejść i „hacków”. Kreski, kiedy pisząc to, mówisz też do siebie: „Wiem, że to nie jest dobry sposób, aby to zrobić, ale na razie będę musiał to zrobić w ten sposób. Przypomnę sobie, żeby później go poprawić …

Odpowiedź

„Dobry” kod ma wiele funkcji , ale najważniejsze, IMHO, to czytelność i łatwość utrzymania.

Twój kod będzie zawierał błędy, prawdopodobnie zostanie rozszerzony i ponownie użyty oraz powinien w pewnym momencie zostać ponownie rozłożony na czynniki – nawet jeśli odwiedzasz go ponownie, są szanse, że nie będziesz mieć pojęcia, co do cholery zrobiłeś w pierwszej kolejności, sobie przysługę i nie stawiaj żadnych barier na drodze.

Jasne, użyj tego złożonego, ale niezwykle wydajnego algorytmu, ale upewnij się, że poświęcisz trochę więcej czasu na jego dokumentowanie, ale poza tym kod jasny i spójny.

Co to znaczy napisać “ dobry kod ”? [zamknięte]

Dodaj komentarz Anuluj pisanie odpowiedzi