Wie zitiere ich Symbole in einer Dokumentationszeichenfolge?

8

In der Emacs Lisp-Dokumentation `buffer-file-name'stoße ich häufig auf zitierte Symbole wie in Docstrings. Das Interessante dabei ist die Art des Zitierens, indem der Symbolname mit einem Backtick und einem Zitat umgeben wird. Ich war neugierig, woher dieser Stil kommt. Nach dieser Antwort könnte es sich um einen begrenzten Zeichensatz handeln.

Zu beachten ist auch, dass diese in Anführungszeichen gesetzten Symbole eine Syntaxhervorhebung aufweisen emacs-lisp-mode, während Symbole, die nur in einfache Anführungszeichen gesetzt werden, z. B. 'Pufferdateiname', keine Syntaxhervorhebung erhalten.

Dies weist also darauf hin, dass die Backtick-Quote-Syntax in Emacs eine bekannte Konvention sein muss. Aber nachdem ich die Dokumentation gegoogelt hatte, konnte ich sie nirgendwo erwähnen. Im Emacs Lisp-Handbuch gibt es einen Abschnitt mit dem Namen "Tipps für Dokumentationszeichenfolgen" . es sagt

Wenn sich eine Dokumentationszeichenfolge auf ein Lisp-Symbol bezieht, schreiben Sie es so, wie es gedruckt wird (was normalerweise in Kleinbuchstaben bedeutet), mit einfachen Anführungszeichen.

Der Zitierstil wird jedoch nicht erwähnt.

Geben Sie ein C-h f thing-at-point RETund klicken Sie dann auf den Link zum Quellcode, um weitere Beispiele für den Anführungszeichenstil anzuzeigen:

(defun thing-at-point (thing & optionale no-properties) "
Geben Sie das THING at point zurück. THING sollte ein Symbol sein, das einen Typ einer
syntaktischen Entität angibt . Zu den Möglichkeiten gehören" symbol "," list "," sexp ",
" defun ". , "Dateiname", "URL", "E-Mail", "Wort", "Satz", "Leerzeichen",
"Zeile", "Nummer" und "Seite".

Wenn das optionale Argument NO-PROPERTIES nicht null ist, entfernen Sie die Texteigenschaften
vom Rückgabewert.

In der Datei "thingatpt.el" finden Sie eine Dokumentation zum Definieren eines
Symbols als gültiges Ding. "

All dies gibt einen Hinweis darauf, dass man den Backtick-Anführungszeichen-Stil verwenden sollte, um Symbole zu zitieren. Ist dieser Stil jedoch irgendwo dokumentiert?

Håkon Hægland
quelle
1
Sind Sie mehr daran interessiert, Dokumentation zu "Anführungszeichen" zu finden, oder möchten Sie wissen, wofür sie gedacht sind? In letzterem Fall handelt es sich um Querverweise: Sie können auf diese Symbole im Hilfepuffer klicken und gelangen zum entsprechenden Hilfepuffer für das Symbol, auf das Sie geklickt haben.
Dan
1
Eine Randnotiz: Wenn Sie eine Schriftart mit Unicode-Zeichen verwenden, können Sie die Anzeigetabelle ändern, um bessere Zeichen für die Anführungszeichen zu verwenden. Alternativ können Sie die Schriftsperre verwenden, um den Sonderfall "Symbol" zu erkennen.
Lindydancer

Antworten:

11

Die Konvention ist in dem Abschnitt dokumentiert, auf den Sie bereits verwiesen haben (Tipps für Dokumentationszeichenfolgen). Der Zweck der Zitate wird erwähnt und es werden Beispiele bereitgestellt:

 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'.

Es hört sich so an, als ob Sie neugierig sind, warum dies single quotesin diesem Zusammenhang wirklich bedeutet

`this' 

eher, als

'this'

Diese Darstellung von linken und rechten Anführungszeichen unter Verwendung des ASCII-Backticks (schwerwiegender Akzent) und des einfachen Anführungszeichens (Apostroph) scheint an einer Stelle eine übliche UNIX-Konvention gewesen zu sein, und als solche vermute ich, dass es nicht wert war, im Emacs-Handbuch weiter erläutert zu werden wurde geschrieben.

Laut diesem Beitrag haben die alten X Window System-Schriftarten und Begriffsschriftarten dazu geführt, dass diese Symbole eher wie echte Anführungszeichen aussehen.

Glucas
quelle