知识卡片
局部注释解释难懂的实现意图
字符串外的#使其后文本成为注释,适合解释局部难点、选择原因和限制。模块、函数、类的使用方式可放在能被文档工具提取的docstring中;两者分工比只重复每行代码更能帮助维护。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
较小功能的文档(例如,“这个奇怪的表达式做这些事”)。马上就会介绍文档字符串了。
参考来源
- 位置:《Python学习手册(原书第4版)》第15章《#注释》(spine688;extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part0659.html;u338-ch15-002)。
- 结论依据:原文在“较小功能的文档”附近的定义、例子或代码支撑本卡核心说明:字符串外的#使其后文本成为注释,适合解释局部难点、选择原因和限制。边界按已读前提解释;示例未执行。
- 原始内容:较小功能的文档(例如,“这个奇怪的表达式做这些事”)。马上就会介绍文档字符串了。