开源代码整洁之道

92 阅读1分钟

一般来说,减少目录的嵌套有助于更直观的看清代码的抽象层次,所以大部分优秀的开源库都喜欢以 前缀-功能 命名目录、文件和方法

文件

1.目录命名

前缀-功能 命名目录,比如

compiler-处理和编译相关的内容

reactivity-处理响应式相关的内容

image.png

2.文件命名,与目录命名类似

image.png

3.方法名称,与目录命名类似

方法除了命名上的书写,其次也更加注重排序聚集

如相同前缀的方法尽可能写在一块

image.png

超大单文件

以typescript的parser模块为例源码为例,单个文件的源码超过1w行,但也同样遵循这样的命名结构

image.png

其它

推荐一款变量命名查询工具,可以作为变量命名的参考

unbug.github.io/codelf/

image.png