Varför kommentarer på samma rad?

De allra flesta verkar placera kommenater för t.ex. variabler på samma rad. Detta är även vad Doxygen verkar rekommendera. Finns det någon speciell anledning till detta mer än att koden får färre antal rader?

Personligen upplever jag det nämnligen som mer svårläst, då raderna i vissa fall kan dra ut mot höger, vilket gör det mer svårläst. Samtidigt blir koden iofs mer enhetlig då kodrader inte avbryts med kommentarer.

Är det flera meningar passar det bättre ovanför men om det bara är ett par tre ord känns det mer sammanhängande att ha det på samma rad. Det är nog bara en ren smaksak dock.

Den mest lättlästa koden har inga kommentarer. Och inga jjävla prefix (tex _sum), förstår inte varför i övrigt duktiga programmerare envisas med det.

Iofs sant kanske. Linux-kärnen har ju dock 8 teckens indent, vilket ju gör att det drar ut ännu mer till höger...? Argumentet mot det enligt deras guide är ju dock att om man behöver mer än 3 indent-nivåer så borde man se över sin kod.


Varför inga prefix? Att ha _ som prefix brukar ju dock avrådas då dessa ska vara reserverade för standardsbiblioteket. Men vad är problemet med t.ex. p_data för att indikera att det är en pekare?
Tänker att det underlättar att se vad det är för variabel man har att göra med?

För att någon annan ska kunna felsöka koden om 10 år när den är inbäddad i en komplexare situation. Det går väl att dölja kommentarer om man för stunden inte vill se dem.

Haha, får mig att tänka på denna gamla meme: https://www.multicians.org/thvv/realprogs.html
särskilt denna: 'Real Programmers don't comment their code. If it was hard to write, it should be hard to understand.'
Den var gammal redan för trettio år sedan när jag såg den för första gången, tänker folk fortfarande såhär på allvar?

Tråkigt att höra att du inte fått tillfälle att jobba med större program än så.

Jag delar i viss mån fletchmans åsikt. Inte av orsaken i Real Programmers-memet, utan för att jag ser det som ett litet misslyckande varje gång jag tvingas skriva en kommentar. De behövs ju endast när koden i sig inte är det mest tydliga sättet att uttrycka vad man vill ha sagt. I regel tycker jag att programkod är mer begriplig än naturliga språk - inga tvetydigheter (undantaget undefined behaviour), underförstådda saker eller syftningsfel.
När man behöver skriva en kommentar så behöver man det för att man har misslyckats med att producera begriplig kod.

Sedan bör det så klart finnas dokumentation tillhörande funktioner som beskriver deras syfte och förväntade beteende, men att känna att jag behöver skriva en kommentar mitt i en funktion som berättar vad ett par kodrader gör gör alltid att jag stannar upp och tänker ett extra varv på om det kanske går att formulera om till kod som är begripligare än engelska.

prefixet _ är i vart fall inom JS en kodkonvention för en intern (osynlig) variabel, som det inte är meningen att användaren ska pula med. Trodde detta kom från C-världen?

Edit: Yep. https://stackoverflow.com/questions/...harp-variables

Kloka synpunkter, jag håller med. Överdrivet och rörigt kommenterad kod är ju minst lika förvirrande som rörigt skriven kod.
Men har man jobbat i förvaltning och med andras kod uppskattar man begriplig och tydlig kod, med begriplig och korrekt dokumentation, och även kommentarer, där det behövs.

Tycker att det är fult med kommentarer på samma rad. Fast jag kommenterar i princip aldrig något.

Enda gången det görs är om det är det typ "TODO" eller om det är något riktigt oförklarligt "hack".

Just när det gäller variabeldeklaration är det enklast att ha ev. kommentarer på samma rad, då kommentarer en rad ovanför skulle ge en väldigt lång lista för deklarationerna. Vanligen är ju även kommentarer för att beskriva variabler väldigt korta så då kan man lika gärna ha det på samma rad.