Как я могу предоставить помощь для соответствующего набора функций?

Question

Я построил tfs.el, чтобы разработчики могли делать вещи TFS (checkout, checkin и т. Д.) Из emacs.

Есть 13 интерактивных команд в пакете TFS, как tfs/checkout, tfs/rename, tfs/diff, и так далее, и я хотел бы быть в состоянии оказать помощь на всех из них в одном месте. Обзор всех доступных функций.

Что такое «способ emacs» от этого? Я думал об определении дополнительной функции, такой как tfs/help, которая будет вызывать describe-function-1 для каждой из функций tfs, а затем представлять все это в буфере TFS-справки.

Есть ли лучший способ?

Answer 1

Вы можете использовать

(describe-bindings "\C-xv") 

Answer 2

Ну, есть много способов «Emacs».

Наиболее полированные бы написать информация страницу, смотрите страницу "Info for Experts", которая в основном говорит использовать Texinfo и преобразовать его в информация страницы. Вы можете быть настолько подробным, насколько хотите, и пользователь может искать, использовать гиперссылки и т. Д. Пользователь может легко добраться туда через C-h F tfs/checkout.

Другой способ некоторые люди, кажется, делают это, чтобы написать короткие строки документации для каждой из команд, заканчивая «смотрите в документации по tfs-mode для деталей» и поставить все общие документы в docstring для TFS-режиме.

Другой способ, с помощью которого некоторые документы документируют документы, содержит большой комментарий в верхней части файла tfs.el.

Воспользуйтесь своим выбором, все они имеют компромиссы.

Answer 3

У вас есть несколько, связанных команд. До сих пор, я думаю, они связаны только их именами.

Две возможности прийти на ум:

• Создать режим для этого материала. Документируйте все в строке документа команды, которая включает/выключает режим. Это может быть основной режим или второстепенный режим. Если второстепенный режим, это может быть буферно-локальным или глобальным.

• Создайте группу (defgroup) для этого материала и запишите все в своей строке документа.

Основная идея заключается в том, чтобы как-то на самом деле относятся эти команды: объединять их в некотором роде, так что вы можете документировать их вместе, как документ для расслоения.

Оффлайн, не зная больше, я предполагаю, что вы можете создать глобальный второстепенный режим.