知识卡片

普通读书笔记卡 · 6333.d.2

文档字符串依赖定义中的位置

理解等级:中级

模块、函数、类或方法定义体的首条字符串字面量可成为其docstring,并通过对象.doc读取。前面的普通注释和空行不妨碍该位置;任意位置的三引号字符串却不会自动变成该对象的文档。打印属性是查看文本,不能替代把准确说明写进源码。

docstr.py把模块、func、spam类和method的文档写在各自定义体开始位置,通过相应doc获取。可以用三重引号写多行,但不是必须三重引号,也不是任意位置的字符串字面量都会成为该对象的文档字符串;优化等配置也可影响文档保留。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 2 处

    • · 查看原书依据

      成为相应对象的__doc__属性。 用户定义的文档字符串 例如,考虑下面的文件docstrings.py。其文档字符串出现在文件开端以及其中的函数和类的开头。在这里,文件和函数多行注释使用的是三重引号块字符串,但是任何类型的字符串都能用。我们还没详细研究def或class语句,所以,除了它们顶端的字符串外,其他关于它们的内容都可以忽略。 这个文档协议的重点在

    • · 查看原书依据

      结构的顶部的字符串常量,由Python在相应对象的__doc__属性自动保存。它适用于模块文件、函数定义,以及类和方法。 既然我们了解了有关类和方法的知识,如下的文件docstr.py提供了一个快速但全面的示例,来概括文档字符串可以在代码中出现的位置。所有的这些都可以是三重引号的块: 文档字符串的主要优点是,它们在运行时能够保持。因此,如果它们已经编写为文档

    参考来源

    - 位置:《Python学习手册(原书第4版)》第15章《文档字符串:__doc__》(spine690;extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part0661.html;u340-ch15-004)。 - 结论依据:原文在“成为相应对象的__doc__属性”附近的定义、例子或代码支撑本卡核心说明:模块、函数、类或方法定义体的首条字符串字面量可成为其docstring,并通过对象.__doc__读取。边界按已读前提解释;示例未执行。 - 原始内容:成为相应对象的__doc__属性。 用户定义的文档字符串 例如,考虑下面的文件docstrings.py。其文档字符串出现在文件开端以及其中的函数和类的开头。在这里,文件和函数多行注释使用的是三重引号块字符串,但是任何类型的字符串都能用。我们还没详细研究def或class语句,所以,除了它们顶端的字符串外,其他关于它们的内容都可以忽略。 这个文档协议的重点在 - 位置:《Python学习手册(原书第4版)》第28章《回顾文档字符串》(spine917;extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part0888.html;u630-ch15-004)。 - 结论依据:docstr.py把模块、func、spam类和method的文档写在各自定义体开始位置,通过相应__doc__获取。可以用三重引号写多行,但不是必须三重引号,也不是任意位置的字符串字面量都会成为该对象的文档字符串;优化等配置也可影响文档保留。 - 原始内容:结构的顶部的字符串常量,由Python在相应对象的__doc__属性自动保存。它适用于模块文件、函数定义,以及类和方法。 既然我们了解了有关类和方法的知识,如下的文件docstr.py提供了一个快速但全面的示例,来概括文档字符串可以在代码中出现的位置。所有的这些都可以是三重引号的块: 文档字符串的主要优点是,它们在运行时能够保持。因此,如果它们已经编写为文档