当前位置 博文首页 > lyndon_li的博客:你的代码在第几层?

    lyndon_li的博客:你的代码在第几层?

    作者:[db:作者] 时间:2021-06-10 18:16

    代码金字塔

    代码质量可以用金字塔结构来表示,从下往上共有 5 个层次。
    在这里插入图片描述

    第一层:正确(Correct)

    代码是否执行预期的工作?是否考虑了边缘情况?是否经过充分测试?是否有可维护性?是否有可接受的性能?

    第二层:安全(Secure)

    代码是否存在漏洞?数据是否安全存储?个人识别信息(PII)是否得到正确处理?是否对用户的输入进行了全面的验证?

    第三层:可读(Readable)

    代码是否易于阅读和理解?测试足够简洁吗?变量、函数、类的名称是否适当?使用领域模型是否可以清晰地映射现实世界,以减少认知负担?是否使用一致地编码风格约定?

    第四层:优雅(Elegant)

    代码是否利用了众所周知的编程模式?能否更简洁地实现所需功能?你会为编写这些代码感到兴奋吗?你为这些代码感到骄傲吗?

    第五层:利他主义(Altruist)

    别人能否从这些代码学到东西?这些代码是否会激励其他工程师进行改进?它是否会让世界变成一个更美好的地方?

    参考

    Maslow’s pyramid of code review