Svenska ElektronikForumet

He, jo så är det ju.
Vi har programkommentarer som "Skicka till lager PDP'n..."
fast det är över 15 år sedan PDP'n ersattes av annat.
Och en massa andra referenser till omgivande system
som är utbytta sedan långt tid tillbaka. Om man har tur så
hittar man någon som har varit med en tid som kan tala
om att, ja det där ersattes av xxx 98-någongång...

Problemet är inte vad man ska/bör göra, problemet är att se till att det blir gjort.

När man skriver grundkoden är det ju jättelätt att lägga in kommentarer om vad den gör. Sen blir det nån buggfix, klart man kommenterar den så ingen annan göra samma misstag. Men så upptäcker man en liten klantgrej som man tycker är solklar och ändrar koden men glömmer ändra kommentaren. Och vips har man kod och kommentering som inte matchar.

Det går såklart att upptäckt sånt med väldigt noggrann kodgranskning, men sån kodgranskning bli alldeles för dyr för de flesta applikationer.

Nu har jag läst igenom det exempel som sodjan hänvisar till.
Jag anser att det är överdokumenterat. Man måste anse att programmerare kan förstå syntaxen, står det Lda A skall man inte behöva kommentera ;Ladda A!
Om man skriver pseudokod kan den utgöra grunden för kommentarer.
Om nästa man kapslar gammal kod och låter den vara kvar tillsammans med datum och orsak har man kommit långt.
Men som sagt, exemplet är inte bra i mina ögon.

Nej, det är inget exempel på "normal" kommentering av källkod.
Men det var ett exempel som jag vet att det hänvisades till
då någon hade problem med USART'en. Det är ju en en slags
kombination av tutorial och kod. En tutorial som även går
att assemblera direkt. Skit samma...

Ber om ursäkt att jag läste och skrev kommentar. Läste att det var ett exempel!
Men som vanligt så missförstod jag säkert ordet!

Ja, det var säkert ett exempel på *någonting*...