关注代码质量(二)

昨天写完了关于包结构的那篇后,意犹未尽的又想了想。觉得对包结构的要求可以归结为一句话:
好的包结构应该保证系统代码结构的清晰和稳定。

关于代码质量,我所能想到的其它几个方面包括:

好的代码风格应该便于阅读和理解,以保证代码的业务逻辑和业务含义的清晰、明确。

无论是缩进、换行,还是命名、注释,代码风格的关注点与代码实现的功能无关,而是代码背后的业务背景。

好的功能实现应该为功能的正确和完备、效率和性能,以及维护和扩展提供保障。

正确和完备要求保证正向流程和异常流程都得到妥善处理;效率和性能不用多说;维护和扩展很大程度上依赖于系统的设计。

好的日志记录应该能有效的展示系统运行时的状态。

比如标识符(线程id或者用户唯一标识符)等,比如方法的入参、返回值等;比如流程节点的判断值等。

包结构和代码风格可以通过必要的规范来统一要求。功能实现和日志记录需要一些内功修为。