Solo per curiosità, ho iniziato a chiedermi se un linguaggio che non consente i commenti avrebbe prodotto un codice più leggibile in quanto si sarebbe costretti a scrivere un codice di auto-commento.

Inoltre, potresti scrivere codice errato come prima perché non ti interessa. Ma qual è la tua opinione?

Penso che i programmatori troverebbero un altro modo per aggiungere commenti ...

string aComment = "This is a kludge.";

Non penso sia così semplice:

anche in un codice ben scritto e autocomponente, ci sono situazioni legittime in cui dovresti scrivere commenti.

Supponendo che tu sia un programmatore perfetto (cosa che non sei, ma supponiamo solo) ...

Ci sono molti effetti non visibili che possono accadere nel codice quando si interfaccia con cose che non sono state scritte. Ad esempio, ci possono essere difetti di progettazione nella libreria di qualcun altro o (se sei uno sviluppatore del kernel) nell'hardware di qualcun altro. Avere commenti per spiegare perché hai usato kludge particolare in un determinato posto può essere essenziale per comprendere il codice e assicurarti che kludge non venga rimosso (rompendo le cose).

È difficile per me avvolgere la mia mente sull'idea che la rimozione di opzioni da una lingua renderebbe in qualche modo migliori i programmi scritti in tale lingua. I commenti non sono obbligatori e anche scrivere codice auto-documentante non lo è.

Non vi è alcun sostituto per le buone pratiche di sviluppo.

In teoria, COBOL è stato originariamente progettato in modo tale da significare che si autodocumentava in modo sufficiente che anche i non sviluppatori (ovvero i supervisori) potevano rivedere il codice scritto e determinare cosa stava succedendo. Tuttavia, in pratica, man mano che un programma diventa più complesso, è difficile comprendere tutto ciò che sta accadendo esclusivamente attraverso il codice.

Durante la rimozione commenti potrebbe costringere alcuni sviluppatori a scrivere codice che è meglio a documentazione di sé, ci sono ancora gli sviluppatori là fuori che scrivere codice scarsamente documentata (ad esempio i nomi delle variabili di a, b, c, ecc) ed è quelle abitudini che le persone hanno bisogno di essere formati fuori di Di. In questi casi, la rimozione dei commenti non influirebbe su quegli sviluppatori e potrebbe ostacolare gli sforzi di altri sviluppatori per spiegare pezzi di codice complessi.

Ogni programma viene scritto per implementare requisiti funzionali che sono al di fuori del programma, sia scritti o semplicemente nella testa di qualcuno.

Penso che la funzione più essenziale dei commenti sia quella di stabilire una mappatura tra i requisiti e il codice. Il motivo per cui è necessaria la mappatura è consentire modifiche incrementali. Quando si verifica una modifica ai requisiti, è necessario apportare le modifiche corrispondenti al codice, se il codice deve rimanere una soluzione ai requisiti. I commenti servono come tabella di marcia per le modifiche.

Se il linguaggio è un linguaggio specifico specifico di dominio (DSL) perfettamente adattato al problema da risolvere, la mappatura dovrebbe essere un semplice isomorfismo e i commenti non sarebbero necessari. Il codice sorgente avrebbe semplicemente indicato il problema e nient'altro avrebbe dovuto essere detto. La soluzione del problema sarebbe sepolta nell'attuazione della lingua.

Poiché le lingue in cui lavoriamo non sono tali DSL e rimarranno tali per qualche tempo, abbiamo ancora bisogno di commenti . È una questione di laurea. A volte il problema è una buona corrispondenza con la lingua attuale, ma di solito no.

Guarda anche...

Lavoro da qualche parte che non consente commenti in linea (cioè puoi avere solo commenti nella parte superiore delle funzioni). No, non semplifica la lettura del codice. Lo rende peggio di ordini di grandezza.

Evito di commentare il codice e funziona.

Evito tutti i commenti in-code (inline o stream) a favore di docblock + variabili significative + programmazione spartana , e funziona.

E sì, so che i blocchi di documenti sono tecnicamente commenti, tuttavia sono in realtà complementari al codice, non invadenti e "standardizzati" ... tutto ciò che un commento comune non lo è.

Quello che penso potrebbe funzionare come sostituto dei commenti: un linguaggio / sintassi / linguaggio standardizzato per i docblock, qualcosa come le annotazioni in java.

Non solo non influirebbe sulla qualità, come altri hanno osservato, sarebbe davvero fastidioso.

Sono sicuro che molti di noi hanno fatto qualcosa del genere di volta in volta:

foreach ( myObject obj in SomeList )
 {
    Debug.Writeline( obj.Name );
//  for some reason this isn't working
//  obj.SetArielPotency( setting );
//  obj.DoSomeProcess();       
 }

Quanto sarebbe irritante se non potessi commentare alcune righe di codice per capire da dove proviene quel bug?

Indipendentemente dai commenti su come funziona il codice, semplici cose pratiche come quella o far cadere una TODOnota conveniente sono cose che rendono più facile risolvere problemi minori e ricordare cosa stavamo facendo quando abbiamo iniziato a scrivere il codice.

I commenti sono come un sommario del libro. Certo, puoi capire tutto leggendo il codice, ma perché mai vuoi leggere un'intera pagina quando potrebbe essere riassunta in una riga commentata?

Mentre sono d'accordo con le altre risposte che anche il codice di auto-documentazione necessita di commenti, ciò è rilevante solo per le lingue attuali .

Penso che la vera domanda sia: "È possibile progettare un nuovo linguaggio di programmazione che non ha bisogno di commenti?" Dovrebbe essere piuttosto alto livello con una grande quantità di astrazione. Ogni affermazione e funzione sarebbero costrette ad essere leggibili tramite la sintassi del linguaggio.

I programmatori indisciplinati scriveranno codice errato, indipendentemente dalla lingua.

Intrigante che Python, che ha solo per convenzione (_-prefisso), non fa alcuno sforzo per sorvegliare questo, e molto codice è ancora in fase di scrittura.

Rant: A volte penso che lingue più permissive costringerebbero più persone a imparare a programmare correttamente, piuttosto che il contrario (cioè l'unico modo per Java e dannazione che tu sia se vuoi pensare alle funzioni come oggetti di prima classe).

Immagino: probabilmente no. Perché? Perché dovresti codificare "perché" come un formalismo nella lingua e perché "perché", sia codificato in lingua che commentato in lingua è comunque sottoutilizzato dai programmatori.

Il codice può certamente essere un auto-commento nello spiegare cosa sta facendo, ma non è sempre possibile per il codice spiegare perché lo sta facendo. È qui che i commenti sono maggiormente necessari.

Se, ad esempio, è necessaria una sezione di codice per conformarsi a un regolamento specifico, come si spiega senza un commento? Se l'algoritmo utilizzato da un particolare pezzo di codice è descritto in un articolo scritto nel 1998 da M. Matsumoto e T. Nishimura, come si spiega senza un commento? Se un algoritmo non fornisce esattamente la funzionalità ottimale ma fa un compromesso giustificato molto specifico che può causare problemi futuri in caso di modifica di altro codice, come si spiega senza un commento?

Che cosa succede se una sezione del codice è stata verificata da un revisore indipendente in modo che non possa essere modificata senza invalidare tale verifica e il codice viene utilizzato per costruire un prodotto la cui conformità con tale verifica è richiesta dai clienti. Come lo indichi senza un commento?

Ho sempre pensato che sarebbe bello avere un commento di una sola parola in modo che se si anteponesse una parola con un simbolo (diciamo due punti), quella parola sarebbe ignorata. In questo modo, avresti potuto dire un lisp che consentiva solo commenti di una sola parola all'interno di un'espressione s. Ad esempio, potresti trasformare questo:

(if (= x y)
    x
    y)

... in questo:

(if (= x y)
    :then x
    :else y)

Se è assolutamente necessario, è possibile concatenare più commenti di una sola parola per formare un commento incorporato:

(if x :Remember, :x :could :be :nil!
    ...)

Certo, questo è un dolore da digitare. In effetti, questo è il punto. Ti incoraggia a usare i commenti in linea con parsimonia e a mantenerli brevi e pertinenti. Ma ho la sensazione che avrei avuto difficoltà a convincere qualcuno ad usare la lingua.

Questo è doppio o niente. Alcuni programmatori non fanno nulla per rendere leggibile il codice. Non consentire commenti rafforzerà questo. Alcuni programmatori scrivono buoni commenti, anche se sarebbero ancora migliori se si trattasse di refactoring del codice anziché di commenti: la rimozione dei commenti può costringerli a fare il refactoring migliore.

Ragioni per cui questa è una buona idea: - Nessuna

Ragioni per cui questa è una cattiva idea: - Ci sono molti più atroci programmatori rispetto ai programmatori buoni ma non grandi - Dovrebbero esserci quasi sempre dei commenti per strani gotcha, riassunti, ecc. - Anche se si evitano i commenti, probabilmente si utilizzerà commenti come palcoscenico lungo la strada: inserisci un commento quando scrivi qualcosa, quindi torna indietro e rifattalo. Ma non puoi sempre farlo immediatamente perché stai ancora imparando. - Incoraggerà le persone a lavorare su di esso - Chi lo userebbe? Le persone che scrivono codice illeggibile e vogliono una scusa (cattiva) e le persone che sono già innamorate dell'idea (che possono semplicemente "non scrivere commenti" per cominciare). Se questo è quello che vuoi, basta scrivere uno standard di codifica che mostri come vuoi che le persone lo facciano.

Ragioni in cui ciò può essere rilevante - Dove potrebbe essere utile è parte di un sistema per migliorare il "non commento", ad es. un linguaggio o IDE che ha un buon supporto per qualcosa di meglio dei commenti e come parte del suo tono, evita i commenti. Non so come funzionerebbe, ma vale la pena pensarci almeno.