¿Cómo citar símbolos en una cadena de documentación?


8

En la documentación de Emacs Lisp, a menudo me encuentro con símbolos entre comillas como `buffer-file-name'dentro de las cadenas de documentos. Lo interesante aquí es el estilo de las citas, al rodear el nombre del símbolo con una marca de retroceso y una cita. Tenía curiosidad de dónde vino este estilo. Según esta respuesta , podría estar relacionado con un conjunto de caracteres limitado.

Otra cosa a tener en cuenta es que estos símbolos entre comillas tienen resaltado de sintaxis emacs-lisp-mode, mientras que los símbolos entre comillas simples, por ejemplo, 'nombre de archivo de búfer', no obtienen resaltado de sintaxis.

Por lo tanto, esto indica que la sintaxis de comillas invertidas debe ser una convención bien conocida en Emacs. Pero después de buscar en Google la documentación, no pude encontrarla mencionada en ningún lado. En el manual de Emacs Lisp hay una sección llamada "Consejos para cadenas de documentación" ; dice

Cuando una cadena de documentación se refiere a un símbolo Lisp, escríbala como se imprimiría (lo que generalmente significa en minúsculas), con comillas simples alrededor.

pero no menciona el estilo de cita.

Escriba C-h f thing-at-point RETy luego haga clic en el enlace al código fuente para ver más ejemplos del estilo de cita:

(defun thing-at-point (thing & opcional no-properties) "Devuelve la
COSA en el punto. LA COSA debe ser un símbolo que especifique un tipo de
entidad sintáctica. Las posibilidades incluyen 'símbolo', 'lista', 'sexp',
'defun' , `nombre de archivo ',` url', `correo electrónico ',` palabra', `oración ',` espacio en blanco',
`línea ',` número' y `página '.

Cuando el argumento opcional NO-PROPERTIES no es nulo, elimine las
propiedades del texto del valor de retorno.

Consulte el archivo 'thingatpt.el' para obtener documentación sobre cómo definir un
símbolo como una COSA válida ".

Entonces, todo esto da una indicación de que uno debería usar el estilo de comillas invertidas para citar símbolos, pero ¿está documentado este estilo en alguna parte?


1
¿Está más interesado en localizar documentación sobre 'símbolos entre comillas' o desea saber para qué sirven? Si es lo último, es para fines de referencias cruzadas: puede hacer clic en esos símbolos en el búfer de ayuda, y lo llevará al búfer de ayuda correspondiente para el símbolo en el que hizo clic.
Dan

1
Una nota al margen, si está utilizando una fuente con caracteres Unicode, puede modificar la tabla de visualización para usar mejores caracteres para las comillas. Alternativamente, puede usar font-lock para reconocer el caso especial de 'símbolo'.
Lindydancer

Respuestas:


11

La convención se documenta en la sección a la que ya hizo referencia (Sugerencias para cadenas de documentación). Se menciona el propósito de las citas y se proporcionan ejemplos:

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

Parece que lo que te interesa es por qué single quotesen este contexto realmente significa

`this' 

más bien que

'this'

Esta representación de caracteres de comillas izquierdas y derechas usando el signo de retroceso ASCII (acento grave) y la comilla simple (apóstrofe) parece haber sido una convención común de UNIX en un punto, y como tal sospecho que no valía la pena explicar más cuando el manual de Emacs fue escrito.

Según esta publicación , las fuentes antiguas del sistema X Window y las fuentes de término hicieron que estos símbolos se parecieran más a citas verdaderas.


Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.