Kommentera och dokumentera

Välkommenterad kod är lättare att jobba med. Väldokumenterad kod lika så. Sitter just nu och försöker förstå mig på olika delar av ett framework. Det finns javadoc till hela alltet, så i teorin ska det inte vara så klurigt. Tillsammans med Eclipse som söker genom javadocen och visar det man behöver precis när och där man behöver det ska det till och med vara riktigt lätt.

Hjälptext om en funktion getQualifiedName() som lyder "If the meaning of the Qualified Name attribute isn't clear, there really should be more of a description here... " hjälper dock inte riktigt. Jotack, gärna, det skulle helt klart underlätta med något av en beskrivning.

Snälla, se till att dokumentera allt ni gör så slipper andra stackare uppleva frustration som den som stundtals fyller mig.