Come citare i simboli in una stringa di documentazione?


8

Nella documentazione di Emacs Lisp, mi imbatto spesso in simboli citati come `buffer-file-name'all'interno di docstrings. La cosa interessante qui è lo stile di citazione, circondando il nome del simbolo con un backtick e una citazione. Ero curioso di sapere da dove venisse questo stile. Secondo questa risposta potrebbe essere correlato a un set di caratteri limitato.

Un'altra cosa da notare è che questi simboli tra virgolette hanno l'evidenziazione della sintassi emacs-lisp-mode, mentre i simboli citati con virgolette singole, ad esempio "nome-file-buffer", non ottengono l'evidenziazione della sintassi.

Quindi questo indica che la sintassi della virgoletta deve essere una convenzione ben nota in Emacs. Ma dopo aver cercato su Google la documentazione, non sono riuscito a trovarla menzionata da nessuna parte. Nel manuale di Emacs Lisp c'è una sezione chiamata "Suggerimenti per le stringhe di documentazione" ; dice

Quando una stringa di documentazione fa riferimento a un simbolo Lisp, scrivila come verrebbe stampata (che di solito significa in minuscolo), con virgolette singole attorno.

ma non menziona lo stile di quotazione.

Digitare C-h f thing-at-point RETe quindi fare clic sul collegamento al codice sorgente per vedere altri esempi dello stile di quotazione:

(defun cosa al punto (cosa e nessuna proprietà facoltativa) "Restituisce la
COSA al punto. COSA dovrebbe essere un simbolo che specifica un tipo di
entità sintattica. Le possibilità includono` simbolo ', `elenco',` sexp ',
`defun' , `nomefile ',` url', `email ',` parola', `frase ',` spazi bianchi',
`linea ',` numero' e `pagina '.

Quando l'argomento facoltativo NO-PROPERTIES è diverso da zero, rimuovere le
proprietà del testo dal valore restituito.

Vedi il file `thingatpt.el 'per la documentazione su come definire un
simbolo come COSA valida."

Quindi tutto ciò dà un'indicazione che si dovrebbe usare lo stile virgoletta per indicare i simboli, ma questo stile è documentato ovunque?


1
Sei più interessato a trovare la documentazione sui `simboli citati 'o vuoi sapere a cosa servono? In quest'ultimo caso, è a scopo di riferimento incrociato: è possibile fare clic su tali simboli nel buffer della guida e verrà visualizzato il buffer della guida corrispondente per il simbolo su cui si è fatto clic.
Dan

1
Una nota a margine, se si utilizza un carattere con caratteri unicode, è possibile modificare la tabella di visualizzazione per utilizzare caratteri migliori per le virgolette. In alternativa, è possibile utilizzare il blocco dei caratteri per riconoscere il caso speciale di "simbolo".
Lindydancer

Risposte:


11

La convenzione è documentata nella sezione a cui hai già fatto riferimento (Suggerimenti per le stringhe di documentazione). Lo scopo delle citazioni è menzionato e vengono forniti esempi:

 Help mode automatically creates a hyperlink when a documentation
 string uses a symbol name inside single quotes ... For example, if
 you write

      This function sets the variable `buffer-file-name'.

Sembra che la cosa di cui sei curioso sia il perché single quotesin questo contesto significhi davvero

`this' 

piuttosto che

'this'

Questa rappresentazione dei caratteri delle virgolette sinistra e destra usando il backtick ASCII (accento grave) e la virgoletta singola (apostrofo) sembra essere stata una convenzione UNIX comune ad un certo punto, e come tale sospetto che non valga la pena di spiegarlo ulteriormente quando il manuale di Emacs fu scritto.

Secondo questo post , i vecchi caratteri di X Window System e i caratteri di termine hanno reso questi simboli più simili a virgolette reali.


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.