Gibt es grundlegende Standards und Praktiken für den Menschen lesbaren Code zu machen?

Question

Insbesondere HTML machen, Java und Python besser lesbar? Hat jemand Vorschläge für diese Programmierung Schüler haben?

Answer 1

1. Verwenden Sie konsistente Gehäuse und Namensgebung.

2. Mit Registerkarten (und Klammern soweit vorhanden) einen visuellen Fluss zur Verfügung zu stellen.

3. Verwenden Sie Kommentare, die erklären, was als technisch konzeptionell als auch geschieht. (Zum Beispiel // Haben wir ein gültiges haben? Nicht // Prüfen, ob benutzer_ID nicht -1)

Ich bin sicher, dass einige weitere erfahrenen Entwickler weitere Vorschläge haben, aber das ist mein Top-3

Answer 2

Die richtigen Einrückungen und informative Kommentare.

Answer 3

Verwenden Vertiefung, Kommentare und Codierungskonventionen (für Python überprüfen PEP8 )

Answer 4

Stellen Sie sicher, dass Ihr Code gut strukturiert (richtige Vertiefung, Leerzeilen getrennte Abschnitte des Codes, etc.) und die Verwendung Standard, konsistent und vollständig benannt (und nicht unverständlich abgekürzt) Variablennamen.

Andere würden unter Verwendung geeigneter Kommentare vorschlagen. Ich würde eher ablehnen. Wenn Ihr Code gut strukturiert ist und Variablen gut genannt, dann würden Kommentare nur Dinge verunstalten. Die Ausnahme von der Regel zu sein, wenn man etwas kontraintuitiv tun muss woanders einen Bug zu umgehen (ich habe in der Vergangenheit dies in WCF und Entity Framework Code mußte zurückgreifen).

Answer 5

Versuchen Sie den Code laut (oder zumindest im Kopf) zu lesen.

Answer 6

Haben Sie einen Blick auf dieses Buch: Clean Code: ein Handbuch der agilen Softwarehandwerk . Es geht um Code lesbar und verständlich zu machen.

Answer 7

Ein Ratschlag ist nicht mit Namen, faul zu sein. Zum Beispiel, wenn Sie eine Java-Klasse haben, die eine Implementierung der Transformator-Schnittstelle ist, und es verwandelt String zu Date, zögern Sie nicht die Klasse StringToDateTransformerImpl zu nennen.

Answer 8

Nun, können Sie immer den "ignorant Test" verwenden. Zeigen Sie Ihren Code an jemanden, der absolut nichts über programmation kennt. Wenn er mehr sehen oder weniger, was eine Funktion der Fall ist, ist der Code wahrscheinlich lesbar.

Answer 9

Die richtige Vertiefung beim Schreiben HTML lebensrettend sein kann, vor allem, wenn Sie mit jeder Art von verschachtelten Elementen sind interagieren. Seien Sie einfach mit der Vertiefung konsistent und sicher sein umgebenden Linien zu aktualisieren, wenn Sie ein vertieftes Element verschieben oder löschen. Dies macht es viel einfacher, die Seite zu aktualisieren, da die Höhe der Vertiefung wird einen Hinweis geben, wo Sie in der Seite sind, ohne irgendeine Art von Strg + F Manövern zurückzugreifen.

Es ist auch erwähnenswert, dass, wenn Sie CSS in Verbindung mit HTML verwenden sind, die richtige Namensgebung entscheidend ist! Es wird Ihren Workflow und die Lesbarkeit des Codes verbessern.

Ich bin auch ein großer Fan von Einzügen, Abständen und Kommentaren, wenn "echten" (Java, Python, C, etc.) dem Schreiben von Code. Ich lehne ich in Richtung (x + 1) über (x + 1), weil ich persönlich denke, dass es einen großen Unterschied in der Lesbarkeit macht. Ich Raum aus Abgüssen, Schritten, usw. und sie fangen meine Augen viel leichter. Seien Sie konsequent mit Halterung / Vertiefung Stil und Kommentar liberal - denken Sie daran, Umschreiben einen Methodennamen ist kein Kommentar