Perché Python non ha commenti multilinea?

OK, sono consapevole che le stringhe a tre virgolette possono servire da commenti su più righe. Per esempio,

"""Hello, I am a 
   multiline comment"""

e

'''Hello, I am a 
   multiline comment'''

Ma tecnicamente parlando si tratta di stringhe, giusto?

Ho cercato su Google e letto la guida allo stile di Python, ma non sono riuscito a trovare una risposta tecnica al motivo per cui non esiste un'implementazione formale di commenti multilinea, / * * /. Non ho problemi a usare le virgolette triple, ma sono un po 'curioso di sapere cosa abbia portato a questa decisione di progettazione.

Dubito che otterrai una risposta migliore di "Guido non ha sentito la necessità di commenti su più righe".

Guido ha twittato su questo:

Suggerimento Python: è possibile utilizzare stringhe su più righe come commenti su più righe. Se non utilizzati come docstring, non generano codice! :-)

I commenti su più righe sono facilmente fragili. Cosa succede se si dispone di quanto segue in un semplice programma di calcolatrice?

operation = ''
print("Pick an operation:  +-*/")
# Get user input here

Prova a commentarlo con un commento su più righe:

/*
operation = ''
print("Pick an operation:  +-*/")
# Get user input here
*/

Spiacenti, la stringa contiene il delimitatore del commento finale.

Il testo tra virgolette NON deve essere considerato commenti su più righe; per convenzione, sono dotstrings . Dovrebbero descrivere cosa fa il tuo codice e come usarlo, ma non per cose come commentare blocchi di codice.

Secondo Guido, i commenti multilinea in Python sono solo commenti a riga singola contigui (ricerca di "commenti blocco").

Per commentare blocchi di codice, a volte uso il seguente modello:

if False:
    # A bunch of code

Questo probabilmente risale al concetto fondamentale secondo cui dovrebbe esserci un modo ovvio per svolgere un compito. Altri stili di commento aggiungono complicazioni inutili e potrebbero ridurre la leggibilità.

Bene, le triple virgolette sono usate come commenti multilinea in docstrings. E # commenti sono usati come commenti incorporati e le persone si abituano.

La maggior parte dei linguaggi di script non ha commenti multilinea. Forse è questa la causa?

Vedi PEP 0008 , sezione Commenti

E vedi se il tuo editor Python offre alcune scorciatoie da tastiera per commentare i blocchi. Emacs lo supporta, così come Eclipse, presumibilmente la maggior parte degli IDE decenti.

Da The Zen of Python :

Dovrebbe esserci uno - e preferibilmente solo un - modo obsoleto di farlo.

Personalmente il mio stile di commento in Java è come

/*
 * My multi-line comment in Java
 */

Quindi avere commenti a riga singola non è poi così male se il tuo stile è tipico dell'esempio precedente perché in confronto avresti

#
# My multi-line comment in Python
#

VB.NET è anche una lingua con commenti a riga singola, e personalmente lo trovo fastidioso poiché i commenti finiscono per sembrare meno commenti di like e più come una sorta di citazione

'
' This is a VB.NET example
'

I commenti a riga singola finiscono per avere un minor utilizzo dei caratteri rispetto ai commenti a più righe e hanno forse meno probabilità di essere sfuggiti da alcuni personaggi malvagi in un'istruzione regex forse? Tenderei ad essere d'accordo con Ned però.

Per commentare un blocco di codice nell'IDE Pycharm :

• Codice | Commenta con Line Comment
• Windows o Linux: Ctrl+/
• Mac OS: Command+/

# This
# is
# a 
# multi-line
# comment

Usa il blocco dei commenti o cerca e sostituisci (s / ^ / # / g) nel tuo editor per raggiungere questo obiettivo.

Ho risolto questo scaricando una macro per il mio editor di testo (TextPad) che mi consente di evidenziare le linee e quindi inserisce # nella prima di ogni riga. Una macro simile rimuove i #. Alcuni potrebbero chiedersi perché sia ​​necessaria la multilinea ma è utile quando si tenta di "disattivare" un blocco di codice per scopi di debug.

Per chiunque sia alla ricerca di commenti su più righe in Python, l'utilizzo del formato a virgoletta tripla può avere conseguenze problematiche, come ho appena appreso nel modo più duro. Considera questo:

this_dict = {
    'name': 'Bob',

"""
This is a multiline comment in the middle of a dictionary
"""

    'species': 'Cat'
}

Il commento su più righe verrà inserito nella stringa successiva, incasinando la 'species'chiave. Meglio usare solo #per i commenti.

Perché la convenzione # è comune e in realtà non c'è niente che puoi fare con un commento multilinea che non puoi fare con un commento # -sign. È un incidente storico, come l'antenato dei /* ... */commenti che risalgono a PL / I,

Supponiamo che siano stati appena considerati non necessari. Dal momento che è così semplice digitare #a comment, i commenti su più righe possono consistere in molti commenti a riga singola.

Per HTML , d'altra parte, c'è più bisogno di multiliner. È più difficile continuare a digitare <!--comments like this-->.

Questa è solo un'ipotesi .. ma

Poiché sono stringhe, hanno un valore semantico (il compilatore non si sbarazza di esse), quindi ha senso che vengano utilizzate come stringhe. In realtà diventano parte dell'AST , quindi l'estrazione della documentazione diventa più semplice.

Inoltre, i commenti multilinea sono una stronza . Mi dispiace dirlo, ma indipendentemente dalla lingua, non li uso per scopi diversi dal debug. Supponi di avere un codice come questo:

void someFunction()
{
    Something
    /*Some comments*/
    Something else
}

Quindi scopri che nel tuo codice c'è qualcosa che non puoi correggere con il debugger, quindi inizi a eseguire il debug manualmente commentando blocchi di codice sempre più piccoli con questi commenti multilinea. Ciò darebbe quindi la funzione:

void someFunction()
{ /*
    Something
   /* Comments */
   Something more*/
}

Questo è davvero irritante.

Commenti multilinea usando IDLE su:

• Mac OS X , dopo la selezione del codice, commenta un blocco di codice con Ctrl+ 3e decommenta usando Ctrl+ 4.

• Windows , dopo la selezione del codice, commenta un blocco di codice con Ctrl+ Alt+ 3e decommenta usando Ctrl+ At+ 4.

Ricordo di aver letto di un ragazzo che avrebbe inserito i suoi commenti su più righe in una variabile a tre virgolette:

x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''

Questo richiede un po 'di memoria, ma ti offre funzionalità di commento multilinea e inoltre la maggior parte degli editor metterà in evidenza la sintassi per te :)

È anche facile commentare il codice semplicemente avvolgendolo con

x = '''

e

'''