Inżynieria oprogramowania readability

4

Czy powinniśmy zmienić nazwę przeciążonych metod?

Załóżmy interfejs zawierający te metody: Car find(long id); List<Car> find(String model); Czy lepiej zmienić ich nazwy w ten sposób? Car findById(long id); List findByModel(String model); Rzeczywiście, każdy programista, który korzysta z tego interfejsu API, nie musi patrzeć na interfejs, aby poznać możliwe argumenty find()metod początkowych . Więc moje pytanie jest …

14 design naming readability method-overloading

4

Czy istnieją jakieś wady łączenia się w metody oparte na metodach referencyjnych?

Niedawno zasugerowałem metodę łączenia dla pewnej klasy w pewnym projekcie, aby poprawić czytelność kodu. Dostałem odpowiedź „płynne interfejsy nie powinny być implementowane tylko dla wygody, ale dla semantyki” i kazałem zrzucić moją sugestię. Odpowiedziałem, że nie sugeruję płynnego interfejsu, ale samą metodę łączenia łańcuchów (obie można pomylić ze sobą, czytać …

14 architecture coding-standards readability method-chaining

4

Jak napisać test dla czystej metody, która nic nie zwraca?

Mam kilka klas, które zajmują się walidacją wartości. Na przykład RangeValidatorklasa sprawdza, czy wartość mieści się w określonym zakresie. Każda klasa walidatora zawiera dwie metody: is_valid(value)która zwraca wartość Truelub Falsezależy od niej i ensure_valid(value)która sprawdza określoną wartość i albo nie robi nic, jeśli wartość jest poprawna, albo zgłasza określony wyjątek, …

13 unit-testing exceptions readability

4

Który sposób zakończenia pętli odczytu jest preferowanym podejściem?

Gdy musisz powtórzyć czytnik, w którym liczba pozycji do odczytania jest nieznana, a jedynym sposobem jest kontynuowanie czytania, aż do końca. Często jest to miejsce, w którym potrzebujesz niekończącej się pętli. Zawsze jest to, trueco oznacza, że gdzieś wewnątrz bloku musi być instrukcja breaklubreturn int offset = 0; while(true) { …

13 c# code-quality readability

6

Czy sigile ułatwiają odczytanie kodu źródłowego?

W większości języków programowania zmienne nie mają znaków identyfikujących, tak jak w PHP. W PHP musisz poprzedzić zmienną $znakiem. Przykład; var $foo = "something"; echo $foo; Tworzę nowy język skryptowy dla aplikacji biznesowych, a moi docelowi użytkownicy nie mają doświadczenia w programowaniu. Czy te znaki ułatwiają czytanie i używanie kodu? …

13 programming-languages readability

1

Jak napisać czytelny kod Clojure?

Jestem nowy w Clojure. Rozumiem kod, który piszę, ale później staje się zbyt trudny do zrozumienia. Trudno dopasować nawiasy. Jakie są ogólne konwencje dotyczące konwencji nazewnictwa i wcięć w różnych sytuacjach? Na przykład napisałem przykładowy przykład de-strukturyzacji, aby go zrozumieć, ale za drugim razem wygląda on całkowicie nieczytelny. (defn f …

13 readability clojure

4

Podkreśl negację

Właśnie pisałem oświadczenie if z dość długimi nazwami nieruchomości i napotkałem ten problem. Powiedzmy, że mamy takie wyrażenie if: if(_someViewModelNameThatIsLong.AnotherPropertyINeedToCheck == someValue && !_someViewModelNameThatIsLong.ThisIsABooleanPropertyThatIsImportant) { //Do something } Druga właściwość jest typu boolowskiego i nie ma sensu mieć podobnego do stetement if(boleanValue == true) Czy istnieje lepszy sposób na podkreślenie …

13 readability

5

Czytelność programowania funkcjonalnego [zamknięte]

Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte 2 lata temu . Jestem tego ciekawy, ponieważ pamiętam, zanim jeszcze nauczyłem się funkcjonalnych języków, uważałem je wszystkie okropnie, …

13 object-oriented functional-programming readability

4

Czy błędem jest używanie flag do wyliczania „grupowania”?

Rozumiem, że [Flag]wyliczenia są zwykle używane do rzeczy, które można łączyć, w których poszczególne wartości nie wykluczają się wzajemnie . Na przykład: [Flags] public enum SomeAttributes { Foo = 1 << 0, Bar = 1 << 1, Baz = 1 << 2, } Jeżeli jakakolwiek SomeAttributeswartość może być kombinacją Foo, …

12 c# .net readability enum

5

Powtarzanie kodu a metoda wieloodpowiedzialna

Staram się przestrzegać zasady pojedynczej odpowiedzialności (SRP), a także pomijać powtórzenia kodu. Jednak często są miejsca, w których istnieją powtórzenia kodu, które są niczym więcej niż blokami kodu wywołań, które są odporne na wyodrębnienie ich do co najmniej sensownej nazwanej metody: DoAction1(); DoAction2(); if (value) DoAction3(); DoAction4(); Jaki jest najlepszy …

11 refactoring readability single-responsibility code-reuse

3

„Statyczny” jako semantyczna wskazówka na temat bezpaństwowości?

Niedawno przeprowadziłem refaktoryzację średniego projektu w Javie, aby wrócić i dodać testy jednostkowe. Kiedy zdałem sobie sprawę, jak trudny jest kpić z singletonów i statyki, w końcu „zrozumiałem” o nich przez cały ten czas. (Jestem jedną z tych osób, które muszą uczyć się z doświadczenia. No cóż.) Teraz, kiedy używam …

11 coding-standards readability coding-style static-methods

6

Co jest łatwiejsze do utrzymania - przypisanie boolowskie poprzez wyrażenie if / else lub wyrażenie boolowskie?

Które można by uznać za łatwiejsze w utrzymaniu? if (a == b) c = true; else c = false; lub c = (a == b); Próbowałem szukać w Code Complete, ale nie mogę znaleźć odpowiedzi. Myślę, że pierwszy jest bardziej czytelny (można dosłownie odczytać go na głos), co, jak sądzę, …

11 .net code-quality readability maintainability clean-code

6

Potrzebuję uczynić mój kod bardziej czytelnym dla innych programistów w moim zespole

Pracuję nad projektem w delphi i tworzę instalator aplikacji, są trzy główne części. Instalacja / dezinstalacja PostgreSQL myapplication (konfiguracja myapplication jest tworzona za pomocą nsi) instalacja / deinstalacja. Tworzenie tabel w Postgresie za pomocą skryptu (pliki wsadowe). Każda rzecz działa dobrze i płynnie, ale jeśli coś się nie powiedzie, stworzyłem …

11 code-quality readability logging

10

Czy funkcje „matematyczne” powinny być zgodne z notacją matematyczną?

Przypuszczam, że to pytanie zostanie natychmiast oznaczone jako subiektywne, ale które według Ciebie jest lepsze: double volume(double pressure, double n_moles, double temperature) { return n_moles * BOLTZMANN_CONSTANT * temperature / pressure; } lub double volume(double P, double n, double T) { return n*R*T/P; } Innymi słowy, czy funkcje implementujące pewne …

11 math coding-style readability

12

Utrzymywalność logiki boolowskiej - czy zagnieżdżanie jest konieczne, jeśli instrukcje są potrzebne?

Który z nich jest lepszy dla utrzymania? if (byteArrayVariable != null) if (byteArrayVariable .Length != 0) //Do something with byteArrayVariable LUB if ((byteArrayVariable != null) && (byteArrayVariable.Length != 0)) //Do something with byteArrayVariable Wolę czytać i pisać drugie, ale pamiętam, że czytanie w kodzie jest kompletne, że robienie takich rzeczy …

11 programming-practices coding-standards maintenance readability

Pytania otagowane jako readability