发帖
雷达卡
作者：麦叔
出处：麦叔编程
引子今年开始，我在翻译一本大部头的，比较经典的Python进阶书籍。
有几页就可以了。这其实是教你很多进阶的Python的语法，更重要的讲解很多设计方法和设计思想。
这些和思想人物的共同点，让你从一个普通人的一个专业方法开始。
昨天我在文档字符串的示例。
我眼睛一亮，觉得有必要跟大家分享一下。
设计需求这个类的功能很简单：
- 类名点，代表二维坐标系中的一个点。
- 属性：x和y代表二维坐标
- 方法：类包含3个方法，实现了“回到原点”，“移动到指点的点”，“计算两个点之间的距离”。
看，你会怎么写呢？
专业级的代码我就直接分享我比较认为的代码吧，请仔细阅读专业，品味其中专业的地方：
类 点： “”” 表示二维几何坐标中的一个点 >>> p_0 = 点（） >>> p_1 = 点(3, 4) >>> p_0.calculate_distance(p_1) 5.0 """ def __init__ (self, x: float = 0 , y: float = 0 ) -> None : """ 初始化新点的位置。x 和 y 可以指定坐标。如果不是，则 点默认为原点。 :param x: 浮点 x 坐标 :param y: 浮点 x 坐标 """ self.move(x, y) def move (self, x: float, y: float) -> None : """ 将点移动到 2D 空间中的新位置。 :param x: 浮点 x 坐标 :param y: 浮点 x 坐标 """自我.x = x self.y = y def reset (self) -> None : """ 将点重置回几何原点：0, 0 """ self.move( 0 , 0 ) def calculate_distance (self, other: "Point" ) -> float: """ 计算距该点的欧几里得距离 到作为参数传递的第二个点。 :param other: 点实例 :return: 浮动距离 """ return math.hypot(self.x - other.x, self.y - other.y)说起来，为什么我认为代码是专业级的：
- 类名和方法名都非常有，没有简单易懂。？
- 通过docstring，类和方法都加了非常简明扼要的文档。看起来就很像库的代码。
- 函数都使用类型提示，增加代码可选项，可以使用 mypy 等类型做检查。
- __init__函数使用了默认值，确保初始化每个实例具有有效的属性。
- reset函数没有自己实现轮子，而是直接调用move方法。
- 类的docstring中提供了使用示例，可以用doctest等测试工具代码做简单的自动化测试。
相关帖子DA内容精选
|
京公网安备 11010802022788号
