Ho una domanda relativa alla programmazione e alla lingua inglese sia: se usare la terza persona o imperativo quando si commentano singole righe di codice. Si supponga seguente riga di codice in un linguaggio imperativo che dovrebbe essere commentato:Stile di commento: Imperativo o terza persona
object.doSomething();
Il mio approccio di commentare questa linea sarebbe quella di mettere il commento alle spalle usando la terza persona come questo sarebbe una frase inglese ordinaria contenente la linea come soggetto:
object.doSomething(); // does (referencing to the line of code) some action
Ma dal momento che ci troviamo in un linguaggio imperativo e quindi in realtà "comandare" il computer, si potrebbe anche pensare di mettere il commento prima del codice e utilizzando imperativo:
//Do some action:
object.doSomething();
Ciò è utile anche quando è necessario commentare più righe correlate tra loro.
Personalmente preferisco il primo stile, ma spesso mi sento insicuro su quale stile usare. Sarebbe bello se qualcuno potesse scrivere la loro esperienza personale qui.
Posto sbagliato da chiedere. I commenti non dovrebbero essere una riformulazione del codice. Ci sono interi libri dedicati alla leggibilità del codice. –
Se hai bisogno di commentare l'intento del codice a livello di linea e non è un codice macchina, hai più problemi di tempo verbale! La mia esperienza personale è che le persone che istituiscono pratiche di commento folle, non mantengono mai i commenti .... –
@BasileStarynkevitch: Ho mantenuto gli esempi semplici al fine di migliorare l'astrazione e la leggibilità di questa domanda. Non presumo commenti al codice di riformulazione come fanno qui, ma per entrare nei dettagli. Dove sarebbe il posto giusto per chiedere ?; non vedo il forum inglese da fitting di StackExchange perché a mio parere questa domanda è fortemente correlata alla codifica. – Paranaix