一些编程系统,例如 Emacs,为每个函数、命令或变量提供文档字符串。您可能会想通过编译文档字符串并编写一些额外的文本来围绕它们来编写参考手册,但您绝对不能这样做。这种方法是一个根本性的错误。对于手册来说,编写良好的文档字符串的文本将完全不适用。
文档字符串需要独立存在——当它出现在屏幕上时,将没有其他文本来介绍或解释它。同时,它的风格可以相当随意。
手册中描述函数或变量的文本不能独立存在;它出现在节或子节的上下文中。本节开头的其他文本应该解释一些概念,并且通常应该提出一些适用于多个函数或变量的一般性观点。本节中之前对函数和变量的描述也将提供有关该主题的信息。为了独立存在而编写的描述会重复其中的一些信息;这种冗余看起来很糟糕。同时,在文档字符串中可以接受的随意性在手册中是完全不可接受的。
在编写好的手册中,使用文档字符串的唯一好方法是将它们作为编写好文本的信息来源。