主要观点:在软件工程中,命名很重要,像utils.py
这样的实用模块存在问题,应改进命名以更好地划分问题域和抽象。
关键信息:
- 命名像诗歌和数学,好的命名能等价于良好的问题域抽象和 API 划分。
utils.py
等实用模块在哲学、实践和社会层面都存在危害,易积累依赖、导致命名冲突等。- 可将实用代码分类为
$PLATFORM_utils
、testing_utils
、$DOMAIN_SPECIFIC_CONCEPT
、base
、$SYSTEM_client
、visualizations
、single-use code 等。 - 可通过
cloc
命令测量代码在“utils”模块中的百分比来评估代码库健康状况,0 - 2%健康,2 - 10%不健康,10%以上则需干预。
重要细节: - 实用模块倾向积累依赖,导致通过
utils
瓶颈使一切都依赖于一切,易产生无意的循环依赖。 - 不同分类的实用代码用途不同,如
$PLATFORM_utils
用于平台相关问题,testing_utils
用于测试过程等。 - 代码库维护者可通过
cloc
命令监测“utils”模块代码百分比的变化,以评估代码库健康状况。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。