Làm thế nào để trích dẫn các biểu tượng trong một chuỗi tài liệu?


8

Trong tài liệu Lisp của Emacs, tôi thường bắt gặp các biểu tượng được trích dẫn như `buffer-file-name'bên trong các tài liệu . Điều thú vị ở đây là phong cách trích dẫn, bằng cách bao quanh tên biểu tượng với một backtick và một trích dẫn. Tôi tò mò không biết phong cách này đến từ đâu. Theo câu trả lời này, nó có thể liên quan đến một bộ ký tự giới hạn.

Một điều cần chú ý là các ký hiệu được trích dẫn này có tô sáng cú pháp emacs-lisp-mode, trong khi các ký hiệu được trích dẫn chỉ bằng dấu ngoặc đơn, ví dụ, 'tên tệp đệm', không nhận được bất kỳ cú pháp tô sáng nào.

Vì vậy, điều này chỉ ra rằng cú pháp trích dẫn backtick phải là một quy ước nổi tiếng trong Emacs. Nhưng sau khi googling tài liệu, tôi không thể tìm thấy nó được đề cập ở bất cứ đâu. Trong hướng dẫn sử dụng Emacs Lisp có một phần có tên "Mẹo cho chuỗi tài liệu" ; nó nói rằng

Khi một chuỗi tài liệu đề cập đến một biểu tượng Lisp, hãy viết nó như nó sẽ được in (thường có nghĩa là chữ thường), với các dấu ngoặc đơn xung quanh nó.

nhưng nó không đề cập đến phong cách trích dẫn.

Nhập C-h f thing-at-point RETvà sau đó nhấp vào liên kết đến mã nguồn để xem thêm một số ví dụ về kiểu trích dẫn:

(defun điều-at-point (điều & bắt buộc không tài sản) "Return các
Thing vào thời điểm. Thing phải là một biểu tượng chỉ định một loại
thực thể cú pháp. Khả năng bao gồm 'biểu tượng '` danh sách', `sexp '
'defun' , `tên tệp ',` url', `email ',` word', `câu ',` khoảng trắng',
`line ',` number' và `page '.

Khi đối số tùy chọn NO-PROPERTIES không phải là con số không, hãy loại bỏ
các thuộc tính văn bản khỏi giá trị trả về.

Xem tệp `thingatpt.el 'để biết tài liệu về cách xác định
biểu tượng là THING hợp lệ."

Vì vậy, tất cả điều này đưa ra một dấu hiệu cho thấy một người nên sử dụng kiểu trích dẫn backtick để trích dẫn các biểu tượng, nhưng phong cách này có được ghi lại ở bất cứ đâu không?


1
Bạn có quan tâm hơn đến việc định vị tài liệu về 'biểu tượng được trích dẫn' hay bạn muốn biết chúng dùng để làm gì? Nếu sau này, nó dành cho mục đích tham chiếu chéo: bạn có thể nhấp vào các biểu tượng đó trong bộ đệm trợ giúp và nó sẽ đưa bạn đến bộ đệm trợ giúp tương ứng cho biểu tượng mà bạn đã nhấp.
Dân

1
Một lưu ý phụ, nếu bạn đang sử dụng phông chữ có các ký tự unicode, bạn có thể sửa đổi bảng hiển thị để sử dụng các ký tự tốt hơn cho dấu ngoặc kép. Ngoài ra, bạn có thể sử dụng khóa phông chữ để nhận ra trường hợp đặc biệt của 'biểu tượng'.
Lindydancer

Câu trả lời:


11

Quy ước được ghi lại trong phần bạn đã tham chiếu (Mẹo cho chuỗi tài liệu). Mục đích của các trích dẫn được đề cập và các ví dụ được cung cấp:

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

Nghe có vẻ như điều bạn tò mò là tại sao single quotestrong bối cảnh này thực sự có nghĩa là

`this' 

thay vì

'this'

Sự thể hiện này của các ký tự trích dẫn bên trái và bên phải bằng cách sử dụng backtick ASCII (dấu trọng âm) và dấu ngoặc đơn (dấu nháy đơn) dường như là một quy ước UNIX phổ biến tại một thời điểm và vì vậy tôi nghi ngờ rằng nó không đáng để giải thích thêm khi hướng dẫn sử dụng Emacs đã được viết.

Theo bài đăng này , phông chữ X Window System cũ và phông chữ hạn làm cho các biểu tượng này trông giống như trích dẫn thực sự.


Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.