是否可以更好地格式化函数的帮助?

时间:2010-12-14 16:34:40

标签: emacs

当我使用describe-function时,我会在帮助缓冲区中显示文档文本。

如果文档足够长,它将包装在缓冲区中,但它不能很好地包装。像这样:

alt text

我可以让docstring使用72个字符的行,但是假设窗口将是80个字符,但情况并非总是如此。

是否可以让describe-function以更精美的格式发布文档?

2 个答案:

答案 0 :(得分:2)

尝试启用global-visual-line-mode以在所有缓冲区中获得精美的文本包装。它适用于代码和帮助缓冲区,但不会弄乱您的行编号!在emacs的所有换行模式中,我发现它是最好的。如果您不想在全球范围内使用它,只需尝试M-x visual-line-mode

答案 1 :(得分:0)

不,请“尝试启用global-visual-line-mode”作为此解决方案。

尝试为doc字符串采用Emacs约定。请参阅Elisp手册,节点Documentation Tips(又名“文档字符串提示”)。

通常,doc字符串的行数不应超过60个字符。

请记住,Emacs有多个地方使用doc字符串,包括apropos。 Emacs希望文档字符串遵循记录的约定,以获得最佳结果。