Откуда взято соглашение о том, чтобы пометить символ символом<символ>в комментариях?
Я вижу это как в справочной странице, так и в строке документа emacs lisp, это выглядит как соглашение; Есть ли официальный документ об этом?
в каком контексте я должен следовать этому правилу?
1 ответ
@lawlist ответил, где вы можете найти документ об этом.
Причина этого соглашения заключается в том, что он позволяет коду, который составляет буфер справки, распознавать вещи такими, какие они есть: переменные, функции, макросы, ключи и т. Д., И помещать на них ссылки, чтобы перенести вас в другие буферы справки. Без соглашения гораздо труднее определить, foo
относится к переменной foo
функция foo
и т.п.