Als «naming-standards» getaggte Fragen

17
Codierungsstandard für Klarheit: Jede Codezeile kommentieren?
Ich habe in Geschäften gearbeitet, die lebenswichtige Software herstellen, und habe mich mit Kommentierungsregeln befasst, die den Code lesbar halten und möglicherweise Leben retten sollten. Meiner Erfahrung nach ist die Anforderung, von einer Checkliste gestrichen zu werden, hirnschmerzhaft und hilft mir nicht, mich darauf zu konzentrieren, verständlichen Code zu schreiben. …
2
Namenskonvention für Python-Dateien?
Ich habe diesen Teil von PEP-8 unter https://www.python.org/dev/peps/pep-0008/#package-and-module-names gesehen Mir ist nicht klar, ob dies auf den Dateinamen eines Moduls / einer Klasse / eines Pakets verweist. Wenn ich jeweils ein Beispiel hätte, sollten die Dateinamen gegebenenfalls in Kleinbuchstaben mit Unterstrichen angegeben werden? Oder etwas anderes?
1
Swift Protocol Naming Conventions [geschlossen]
Ich komme hauptsächlich aus dem C # -Hintergrund und bin es gewohnt, den Begriff "Schnittstelle" zu verwenden, um ein Objekt ohne Implementierung zu beschreiben, die das Verhalten definiert. In c # besteht die Konvention darin, Schnittstellennamen wie in IEnumerableusw. ein "I" voranzustellen . Natürlich hat das Konzept verschiedene Namen in …
9
Wie benenne ich eine Methode, die sowohl eine Aufgabe ausführt als auch einen Booleschen Wert als Status zurückgibt?
Wenn es eine Methode gibt bool DoStuff() { try { // doing stuff... return true; } catch (SomeSpecificException ex) { return false; } } sollte es eher heißen IsStuffDone()? Beide Namen können vom Benutzer falsch interpretiert werden: Wenn der Name der DoStuff()Grund ist, wird ein Boolescher Wert zurückgegeben? Wenn der …
3
Readme.txt vs. README.txt
Ich habe gerade ein Projekt in Github gegabelt, meine Änderungen vorgenommen usw. Das hat mich gefragt: Ich sehe hauptsächlich README.txt in OpenSource-Projekten und die Datei, die ich bearbeitet habe, war Readme.txt. Ist das eine Art von Standardisierung oder hätte ich es so lassen sollen, wie es ist?
2
Warum verwendet Software den Win32-Namen?
Wenn eine Software / Bibliothek Unterstützung für die Windows-Plattform bietet, benennen sie ihre Verzeichnisse und Variablen fast immer als win32. Dies ist am häufigsten in C / C ++ - Projekten der Fall. Auch das MinGW- Projekt zielt auf eine Dreifachnutzung ab win32. Gibt es einen Grund dafür? Warum nicht …
2
Warum sollten laut Konvention DB-Tabellennamen Singular sein, RESTful-Ressourcen jedoch Plural?
Es ist eine ziemlich etablierte Konvention, dass Namen von Datenbanktabellen, zumindest in SQL, Singular sein sollten. SELECT * FROM user;Siehe diese Frage und Diskussion . Es ist auch eine ziemlich etablierte Konvention, dass RESTful API-Ressourcennamen im Plural sein sollten. GET /users/123und POST /userssieh dir das an . In der einfachsten …
3
Sind "Plus" und "Minus" geeignete Methodennamen?
Java SE 8 kommt mit einem neuen Mechanismus für Daten, die Einführung LocalDate, LocalTimeund LocalDateTimeKlassen Zeitmomente darzustellen. Um einen solchen Zeitpunkten eine Reihe von Methoden zu manipulieren sind gegeben: LocalDate.plusDays(...), LocalDate.minusDays(...)und so weiter. Ich habe immer gedacht, dass gute Praxis darin besteht, Methoden nach Verben zu benennen, die ihren Zweck …
7
Welche Idee steckt hinter der Benennung von Klassen mit dem Suffix "Info", z. B. "SomeClass" und "SomeClassInfo"?
Ich arbeite in einem Projekt, das sich mit physischen Geräten befasst, und ich war verwirrt, wie ich einige Klassen in diesem Projekt richtig benennen soll. Angesichts der Tatsache, dass die tatsächlichen Geräte (Sensoren und Empfänger) eine Sache sind und ihre Darstellung in der Software eine andere, denke ich darüber nach, …
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.