Kommentarer är av ondo

Jag tycker att kommentarer skall finnas i kod men det kanske är för att jag själv är så dålig på att koda så jag inte fattar vad jag håller på med Då behöver jag en virtuell post-it

Kommentarer läses normalt som stöd, när man inte förstår vad den riktiga koden gör. Många kommentarer kommer aldrig läsas igen, inte ens av den som skriver kommentaren. Men de är ovärderliga efter ett tag, speciellt för komplicerad kod eller att förstå hur kod hänger ihop. Speciellt i språk som har lång livscykel eller där programmerare byts ut. Man kommer inte ihåg hur man tänkte för 10 år sedan.

Vad jag tror är ett stort problem när kodande diskuteras är att det är få personer som deltagit i stora projekt. Idag är kontrasterna större än någonsin eftersom det finns så mycket ramverk, enklare appar mm. Man kan programmera och bara pysslat med småsaker i relation till att exempelvis bygga någon applikation i språk som C++.
Ramverk är ofta gjorda så att programmeraren är hårt styrd med, ibland så styrd att det man vill göra inte går på grund av ramverket och inte det språk man sitter i.

En annan fördel med att dokumentera är att det finns verktyg som kan parsa ut kommentarerna och göra det hela sökbart, som en slags API dokumentation. Personligen brukar jag lägga in kodexmpel i kommenterar för de klarar ofta "markdown" för bättre formatering.

Doxypress är ett hett tips, den klarar många språk. Finns här: Doxypress

En annan sak angående kodande, nästan alla anammar stilen lowerCamelCase idag. Den här stilen var det SUN med sitt Java som först gick ut hårt med. Java marknadsfördes som ett enklare alternativ till C och C++ samt att man enklare skulle kunna flytta applikationen till olika operativsystem. Något som visade sig vara mycket svårare än marknadsförningen. Gissningsvis tog även javascript efter, det enda som liknar språken java och javascript är visserligen namnen men browsrar och internet började dyka upp i samma veva som SUN gick ut hårt med Java.
lowerCamelCase är troligen den sämsta stilen man kan avända sig av för att få läsbar kod för andra programmerare. Exakt varför SUN valde den stilen vet jag inte men i och med att Java var lite designat för "inte så duktiga" programmerare så kanske man ville bibehålla programmerare på en lägre nivå. Man gjorde helt enkellt språket på ett sätt så de skulle stanna i utvecklingen

                    /*

                    Issue #3997

                    Gamla invoice parser/import-koden fixar inte att man jobbar på befintliga fakturor som detta är. Därav retur av tom lista.
                    Detta är en workaround pga att Skandia inte jobbar med TXID på sin återrapportering.

                    */
                    return Enumerable.Empty<IncomingInvoice>();

Tycker det där är en jättebra kommentar. Just för ytor mellan system—såväl interna som tredjeparts—där koden av någon anledning måste göra något som vid första anblick verkar tokigt är väl lämpade för kommentarer. Skulle säga att det är en välkommen kommentar som inte borde ta emot

Annars håller jag med om att kommentarer sällan har ett egenvärde.

Nu är jag ju bara hobbyprogrammerare, men jag brukar skriva kommentarer där jag inte anser att koden är självförklarande, och för att dela upp i sektioner på ett tydligare sätt. Även vid vissa uträkningar, speciellt de som jag förenklat kan behöva en förklaring till varför den ser ut som den gör och vad vissa siffror kommer ifrån. Någon har säkert en fin kommentar till varför det inte behövs
Håller dock alltid kommentarerna korta, annars förstör det översikten. Finns ju säkert program som kan dölja kommentarer iofs.

Alla testar sin kod, det går inte att utveckla utan att testa. Det skiljer bara lite i tekniker hur man testar men test har funnits så länge man har programmerat

Jag kommenterar. Mina kollegor gör det aldrig. De tycker inte jag borde. Men jag kommenterar ändå.
Exempel på mina enkla kommentarer:

Dessa kommentarer låter mig snabbt se vad kodens uppgift är. Jag tycker att det sparar tid. Jag störs inte av kommentarer så långe de inte ser ut som de Trådstartaren hittat.

Beror helt på språk. JavaScript är det i princip helt omöjligt att garantera datatyper och klassinstancer utan att kommentera med t.ex. jsdoc. I PHP och JavaScript behövs detta för att navigera snabbt med sin IDE, utan detta är det ett helvete att hitta rätt ibland.

Skickades från m.sweclockers.com

Vad är ett automatiskt test?
Det finns massor av tekniker. C++ har en preprocessor och man kompilerar för debug och release (ibland andra varianter), finns oftast massa "assert". Förutom det kan en del ha inspelade sekvenser där programmet körs och skall bete sig på ett visst sätt. En lite ovanlig men som enligt mig varit väldigt bra teknik är att bygga i något skriptspråk i applikationen (om man har möjlighet till det). Exempelvis LUA. Då kan man bygga skript i LUA som körs för att testa i olika miljöer och operativ.

Det enda nya med detta "testade" är att man hittat på massa namn för testmetoder och en del har pysslat med att bygga olika testbibliotek. Vissa har inte fattat och byggt så mycket tester att de fått fasligt svårt att ändra koden

Precis, saker är alltså inte svartvita. Kommentarer är inte alltid dåliga, det finns gott om fall där de är bra. Tester ska inte alltid göras av utvecklaren.

Skickades från m.sweclockers.com