一个文件中包含多少行代码合适

这个问题可以通过一些原则推导出来,很有必要记录一下

原则1#

每个类一个文件

原则2#

人脑通常可以同时追踪7个不同的东西,超过7个就会感到困难

因此在 Linux Kernel 的编码规范中,建议函数内的本地变量不要超过5-10个

同样道理,一个类的成员函数建议不要超过7-10个

原则3#

一个函数的代码不应超过两屏

Linux Kernel 的规范中比较严格,按照 ISO/ANSI 屏幕大小是 80x24,也就是一屏24行,两屏48行

现代计算机通常一屏可以显示50行,两屏就是100行

原则4#

代码首先是给人阅读的,潜在的读者可能是团队的其他成员或是几个月后的自己

所以不要只考虑自己的习惯和配置

推导#

每个类一个文件,每个类中有10个公共函数,10个私有函数,每个函数100行代码

一个源代码文件最大应控制在2000行以内

参考资料#

https://softwareengineering.stackexchange.com/questions/176999/at-what-point-range-is-a-code-file-too-big https://www.kernel.org/doc/html/v4.10/process/coding-style.html#functions

comments powered by Disqus