Domande taggate «comments»

Domande su come scrivere commenti nel codice.

12
I commenti obsoleti sono un mito urbano?
Vedo costantemente persone affermare che "i commenti tendono a diventare obsoleti". Il fatto è che penso di aver visto forse due o tre commenti obsoleti per tutta la mia carriera. Le informazioni obsolete in documenti separati avvengono continuamente, ma nella mia esperienza i commenti obsoleti nel codice stesso sono estremamente …
38 comments  myth 
13
Commento prima o dopo il codice pertinente [chiuso]
Supponendo che un commento non si adatti (o non possa andare) sulla riga a cui si applica, si dovrebbe scrivere il commento prima del codice o dopo? Bene, ovunque i futuri lettori capiranno meglio lo scopo del commento. In altre parole, ovunque la maggior parte dei programmatori / programmatori inserisca …
34 comments 
5
Come vengono generalmente analizzati i commenti?
Come vengono generalmente trattati i commenti nei linguaggi di programmazione e nel markup? Sto scrivendo un parser per un linguaggio di markup personalizzato e voglio seguire il principio della minima sorpresa , quindi sto cercando di determinare la convenzione generale. Ad esempio, un commento incorporato in un token dovrebbe "interferire" …
31 parsing  comments 
6
Guida per principianti alla scrittura di commenti?
Vuoi migliorare questo post? Fornisci risposte dettagliate a questa domanda, comprese le citazioni e una spiegazione del perché la tua risposta è corretta. Le risposte senza dettagli sufficienti possono essere modificate o eliminate. Questa domanda è stata migrata da StackTranslate.it perché è possibile rispondere su Software Stack Stack Exchange. Migrato …
9
Stile e raccomandazioni del codice di commento
Questa domanda è stata migrata da StackTranslate.it perché è possibile rispondere su Software Stack Stack Exchange. Migrato 8 anni fa . Voglio ricevere consigli ed esperienze su come scrivere commenti nel tuo codice. Come li scrivi nel modo più semplice e informativo? Quali sono le tue abitudini nel commentare parti …
6
Come risolvere il problema dei commenti nidificati
Non appare in una sola lingua che i commenti non possono essere nidificati. Hai una buona soluzione per questo problema? Una soluzione alternativa in C / C ++ e Java è utilizzare solo il commento a riga singola ma diventa impossibile quindi commentare un blocco più grande. Sto affrontando qualcosa …
23 java  c++  python  c  comments 
21
Codice di auto-documentazione vs. Codice commentato
Bloccato . I commenti su questa domanda sono stati disabilitati, ma sta ancora accettando nuove risposte e altre interazioni. Per saperne di più . Ho effettuato una ricerca ma non ho trovato quello che cercavo, non esitare a collegarmi se questa domanda è già stata posta. All'inizio di questo mese …
6
Perché è sbagliato commentare il codice e poi rimuoverlo gradualmente per tenere traccia di ciò che ho già fatto e di ciò che resta da fare?
Ogni volta che scopro che una grande parte del mio codice deve essere modificata, sia perché non è corretta o perché deve essere adattata alle principali modifiche architettoniche richieste da altri motivi, questo è ciò che faccio in genere: Commento tutto il codice che sospetto possa essere necessario modificare. Considero …
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.