Pytania otagowane jako naming-standards

17
Standard kodowania dla przejrzystości: skomentować każdą linię kodu?
Pracowałem w sklepach, które produkują oprogramowanie krytyczne dla życia i zajmowałem się regułami komentowania, które miały na celu utrzymanie czytelności kodu i potencjalne uratowanie życia. Z mojego doświadczenia wynika jednak, że wymóg ten staje się umysłem, od którego należy usunąć listę kontrolną i nie pomaga mi skupić się na pisaniu …
2
Konwencja nazewnictwa plików Python?
Widziałem tę część PEP-8 https://www.python.org/dev/peps/pep-0008/#package-and-module-names Nie jestem pewien, czy odnosi się to do nazwy pliku modułu / klasy / pakietu. Gdybym miał jeden przykład każdego z nich, czy nazwy plików powinny być pisane małymi literami, jeśli to właściwe? Albo coś innego?
8
Problemy z nazewnictwem: czy nazwa „ISomething” powinna zostać zmieniona na „Coś”? [Zamknięte]
Rozdział wuja Boba na temat nazw w Czystym Kodzie zaleca unikanie kodowania nazw, głównie w odniesieniu do notacji węgierskiej. On także wyraźnie wymienia usunięcie Iprefiksu z interfejsów, ale nie pokazują przykłady. Załóżmy, że: Wykorzystanie interfejsu służy głównie do testowania poprzez wstrzykiwanie zależności W wielu przypadkach prowadzi to do posiadania jednego …
1
Konwencje nazewnictwa protokołu Swift [zamknięte]
Pochodząc głównie z języka c #, przyzwyczaiłem się używać terminu „interfejs” do opisywania obiektu bez implementacji, która określa zachowanie. W języku c # konwencja polega na dodawaniu nazw interfejsów do „I”, jak w IEnumerableitd. Oczywiście koncepcja ma różne nazwy w różnych językach. W Swift ta sama koncepcja nazywa się „protokołem”. …
9
Jak nazwać metodę, która zarówno wykonuje zadanie, jak i zwraca wartość logiczną jako status?
Jeśli istnieje metoda bool DoStuff() { try { // doing stuff... return true; } catch (SomeSpecificException ex) { return false; } } czy raczej powinno się to nazywać IsStuffDone()? Obie nazwy mogą zostać błędnie zinterpretowane przez użytkownika: Jeśli nazwa jest DoStuff()przyczyną, dla której zwraca wartość logiczną? Jeśli nazwa brzmi, IsStuffDone()nie …
3
Readme.txt vs. README.txt
Właśnie rozwidliłem projekt w Github, wprowadziłem zmiany itp. To mnie zastanowiło: w projektach typu open source widzę głównie README.txt, a edytowany przeze mnie plik to Readme.txt. Czy to jest jakaś standaryzacja, czy powinienem ją zostawić taką, jaka jest?
2
Dlaczego oprogramowanie korzysta z nazwy Win32?
Jeśli oprogramowanie / biblioteka ma pewne wsparcie dla platformy Windows, prawie zawsze nazywają swoje katalogi i zmienne jako win32. Jest to najbardziej rozpowszechnione w projektach C / C ++. Nawet trzykrotne wykorzystanie docelowego projektu MinGWwin32 . Czy jest tego powód? Dlaczego nie użyć prawidłowej nazwy, takiej jak Windows lub Microsoft …
2
Dlaczego XMLHttpRequest nie wydaje się przestrzegać konwencji nazewnictwa?
Ostatnio pracuję z obiektem XMLHttpRequest w JavaScript i nie mogłem nie zauważyć, że obudowa tej nazwy nie ma sensu. Dlaczego „XML” jest pisany wielkimi literami, a „HTTP” nie? Oba są akronimami! Z pewnością bardziej sensowne byłoby, aby nazwa była jedną z następujących: XmlHttpRequest (PascalCase, najlepsza praktyka dla nazw klas w …
2
Dlaczego konwencja mówi, że nazwy tabel DB powinny być pojedyncze, a zasoby RESTful w liczbie mnogiej?
Jest to dość ugruntowana konwencja, że ​​nazwy tabel bazy danych, przynajmniej w SQL, powinny być pojedyncze. SELECT * FROM user;Zobacz to pytanie i dyskusję . Jest to również dość popularna konwencja, że ​​nazwy zasobów interfejsu API RESTful powinny być w liczbie mnogiej. GET /users/123i POST /userszobacz to . W najprostszym …
3
Czy „plus” i „minus” są odpowiednimi nazwami metod?
Java SE 8 jest wyposażony w nowy mechanizm dat wprowadzenia LocalDate, LocalTimei LocalDateTimeklas do reprezentowania chwilach czasu. Manipulować takie momenty, zestaw metod podano: LocalDate.plusDays(...), LocalDate.minusDays(...)i tak dalej. Zawsze myślałem, że dobrą praktyką było nazywanie metod po czasownikach opisujących ich cel, ponieważ metody są w rzeczywistości operacjami do wykonania, czymś, co …
7
Jaki jest pomysł nazewnictwa klas za pomocą sufiksu „Info”, na przykład: „SomeClass” i „SomeClassInfo”?
Pracuję w projekcie, który dotyczy urządzeń fizycznych i byłem zdezorientowany, jak prawidłowo nazwać niektóre klasy w tym projekcie. Biorąc pod uwagę fakt, że rzeczywiste urządzenia (czujniki i odbiorniki) to jedno, a ich reprezentacja w oprogramowaniu jest inna, myślę o nadaniu nazw niektórym klasom za pomocą wzorca nazwy sufiksu „Info”. Na …
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.