Bij het schrijven van code voor een programma is het eenvoudig om alle bugs te repareren en correct te laten compileren, maar het gemakkelijk maken voor een andere persoon om het te lezen, is veel moeilijker. Hier zijn enkele tips die u helpen de leesbaarheid van uw code te verbeteren.

Stappen

  1. 1 Mensen die code onderhouden, zijn nooit zo goed thuis als de oorspronkelijke auteur. Ze hebben mogelijk minder goede programmeervaardigheden en weten minder over het project. Dit is de persoon voor wie je het programma aan het schrijven bent. U wilt dat de code gemakkelijk is voor deze persoon.
  2. 2 Alleen omdat een taalfunctie beschikbaar is in een taal, betekent niet dat je het moet gebruiken. Het doel is om te communiceren wat de code doet met de volgende lezer, niet om indruk te maken op hem met hoe weinig regels je kunt nemen om code te schrijven.
  3. 3 Vaak is een algoritme moeilijk te volgen. Maar vaak wordt het ergens gepubliceerd. Plaats de URI van de documentatie voor het algoritme in het gedeelte Opmerkingen voor de code. Als de URI naar een kortstondige locatie verwijst, kopieert u de informatie ergens waar de codehouder deze kan vinden.
  4. 4 Raadpleeg de coderingsstandaard in de kop van het bestand. Geef indien mogelijk een bestand op dat gereedschappen kunnen openen om de juiste instellingen op te nemen. Als voorbeeld gebruikt Eclipse standaard tabbladen, maar worden tabbladen verschillend weergegeven op verschillende teksteditors. Het gebruik van witte ruimte in plaats van tabbladen kan de voorkeur hebben, maar heeft een bestand dat de juiste instellingen voor een project biedt.
  5. 5 Gebruik witte ruimte. Sla regels over tussen code die andere dingen doen en gebruik spaties na puntkomma's en komma's. Hierdoor wordt uw code er schoner en gemakkelijker leesbaar.
  6. 6 Inspringen in accolades. Dit maakt het zo dat het duidelijk is dat een stuk code gescheiden is van een ander. Dit kan helpen bij het schrijven van een lange methode. Inspringen binnen if-statements en loops maakt het gemakkelijk om te lezen. Deze techniek wordt 'nesten' genoemd, dat wil zeggen dat een stuk code 'genest' is in een ander stuk code en de lezer in staat stelt om eenvoudig het nestpatroon te volgen.
  7. 7 Schrijf beschrijvende opmerkingen. Stel dat de persoon die je code leest niets weet over wat het zou moeten doen. Uw opmerkingen moeten elke stap uitleggen. Alle van uw geavanceerde, verwarrende of gecompliceerde algoritmen moet goed worden becommentarieerd. Probeer ook te beschrijven welk doel de code heeft. Bijvoorbeeld, in plaats van het schrijven van "voeg een toe aan variabele", zeg dan waarom dit belangrijk is in de code, want iedereen kan zien dat het de variabele verhoogt, bijvoorbeeld "verhoog het aantal pagina-hits met 1".
  8. 8 Maak uw code "zelfdocumenterend" door beschrijvende objectnamen te maken die beschrijven wat hun doelen zijn. Objecten moeten verwijzen naar het domein van het probleem of naar standaard software-artefacten. Een lijst is een lijst. Mogelijk moet u een klantenlijst maken die een lijst subclass of implementeert. Variabelen en functieparameters moeten beschrijvende namen hebben.
  9. 9 Neem de oorspronkelijke auteur en de huidige beheerder van de code op in de eerste opmerking van het bestand. Dit vertelt mensen aan wie de code moet worden geleverd.
  10. 10 Reageer vaak. Schrijf opmerkingen om uw intentie aan te geven. Als u uw code toevoegt, leidt dit ertoe dat iemand uw opmerkingen verwijdert.