Como citar símbolos em uma sequência de documentação?


8

Na documentação do Emacs Lisp, frequentemente encontro símbolos citados, como `buffer-file-name'dentro de documentos. A coisa interessante aqui é o estilo de citar, envolvendo o nome do símbolo com uma barra e uma citação. Fiquei curioso de onde veio esse estilo. De acordo com esta resposta , pode estar relacionado a um conjunto de caracteres limitado.

Outra coisa a notar é que esses símbolos citados têm destaque de sintaxe emacs-lisp-mode, enquanto símbolos citados apenas com aspas simples, por exemplo, 'nome-do-arquivo-buffer', não recebem nenhum destaque de sintaxe.

Portanto, isso indica que a sintaxe de cotação de backtick deve ser uma convenção bem conhecida no Emacs. Mas depois de pesquisar a documentação, não consegui encontrá-la mencionada em nenhum lugar. No manual do Emacs Lisp, há uma seção chamada "Dicas para cadeias de documentação" ; diz

Quando uma string de documentação se refere a um símbolo Lisp, escreva-a como seria impressa (o que geralmente significa em letras minúsculas), com aspas simples.

mas não menciona o estilo de citação.

Digite C-h f thing-at-point RETe clique no link para o código-fonte para ver mais alguns exemplos do estilo de citação:

(defun coisa-no-ponto (coisa & sem propriedades opcionais) "Retorna a
coisa no ponto. A coisa deve ser um símbolo que especifica um tipo de
entidade sintática. As possibilidades incluem` símbolo ', `lista',` sexp ',
`defun' , `nome do arquivo ',` url', `email ',` palavra', `sentença ',` espaço em branco',
`linha ',` número' e `página '.

Quando o argumento opcional NO-PROPERTIES não for nulo, retire as
propriedades do texto do valor retornado.

Veja o arquivo `thingatpt.el 'para documentação sobre como definir um
símbolo como uma COISA válida."

Então, tudo isso dá uma indicação de que se deve usar o estilo backtick-quote para citar símbolos, mas esse estilo está documentado em algum lugar?


1
Você está mais interessado em localizar documentação sobre 'símbolos de aspas' ou deseja saber para que servem? Neste último caso, é para fins de referência cruzada: você pode clicar nesses símbolos no buffer de ajuda e o levará ao buffer de ajuda correspondente para o símbolo no qual você clicou.
Dan

1
Uma observação lateral, se você estiver usando uma fonte com caracteres unicode, poderá modificar a tabela de exibição para usar caracteres melhores para as aspas. Como alternativa, você pode usar o bloqueio de fonte para reconhecer o caso especial de `symbol '.
Lindydancer

Respostas:


11

A convenção está documentada na seção que você já referenciou (Dicas para cadeias de documentação). O objetivo das citações é mencionado e são fornecidos exemplos:

 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 o que você está curioso é por que single quotes, neste contexto, realmente significa

`this' 

ao invés de

'this'

Essa representação de caracteres de aspas esquerdo e direito usando o backtick ASCII (acento grave) e aspas simples (apóstrofo) parece ter sido uma convenção comum do UNIX em um ponto e, como tal, suspeito que não valeria a pena explicar mais quando o manual do Emacs foi escrito.

De acordo com este post , as fontes antigas e os termos do sistema X Window fizeram esses símbolos parecerem mais com aspas verdadeiras.


Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.