Ist es möglich, die Hilfe für eine Funktion besser zu formatieren?

Question

Wenn ich describe-function verwende, bekomme ich den Dokumentationstext in einem Hilfepuffer angezeigt.

Wenn das Dokument lang genug ist, wird es in den Puffer umgebrochen, aber es wird nicht gut verpackt. dies wie:

kann ich die docstring Gebrauch mit 72 Zeichen Linien machen, aber das setzt voraus, dass das Fenster 80 Zeichen lang sein wird, was nicht immer der Fall ist.

Ist es möglich, describe-function zu erhalten, Dokumentation in einer besser formatierten Weise zu emittieren?

Answer 1

Versuchen Sie, global-visual-line-mode zu aktivieren, um nette Textumhüllung in allen Ihren Puffern zu erhalten. Es funktioniert in Code- und Hilfspuffern, aber macht die Zeilennummerierung nicht durcheinander! Von allen Zeilenumbruch-Modi für Emacs finde ich es am besten. Wenn Sie es nicht global verwenden möchten, versuchen Sie es einfach M-x visual-line-mode.

Answer 2

Nein, bitte tun Sie nicht "versuchen Sie, Global-Visual-Line-Modus" als Ihre Lösung dafür.

Versuchen Sie einfach, die Emacs-Konventionen für Doc-Strings zu übernehmen. Siehe das Elisp-Handbuch, Knoten Documentation Tips (auch bekannt als "Tipps für Dokumentationsstrings").

Im Allgemeinen sollten Doc-Strings keine Zeilen mit mehr als 60 Zeichen haben.

Denken Sie daran, dass es mehrere Stellen gibt, an denen Emacs Doc-Strings verwendet, einschließlich für apropos. Emacs erwartet, dass Doc-Strings den dokumentierten Konventionen folgen, um die besten Ergebnisse zu erzielen.