zoukankan      html  css  js  c++  java
  • 代码整洁之道

    一、有意义的命名

    • 名副其实
    • 避免误导
    • 使用统一标记风格(Pascal或Camel)
    • 别用双关语
    • 添加有意义的语境(上下文)

    二、函数

    • 短小
    • 只做一件事
    • 名称有意义,使用描述性名称。
    • 合理使用switch和if
    • 别重复自己,多提取公共函数

    三、注释

    • 最好的注释是没有注释
    • 最好的注释是有意义的命名。
    • 好注释描述问题
    • 坏注释胡言乱语
    • 及时更新注释别出现上条问题。
    • 坏注释不如无注释,不能保证注释新鲜,删除注释。

    四、格式

    • 代码排版上下有间隙
    • 代码左右长度不要超过屏幕宽。

    五、错误处理

    • 错误时抛出异常
    • 先写try-catch-finally语言
    • 别返回null,别传递null

    六、边界定义

    • 不重复造轮子,合理使用第三方代码
    • 系统添加防腐层

    七、单元测试

    • 只有通过单元测试的代码才是正在Clean
    • 上述6条只是表面干净

    八、类

    • 类应该短小
    • 单一权责
    • 内聚

    九、系统

    • AOP
    • ASP
    • DI和IOC
  • 相关阅读:
    shell习题第21题:计算数字的个数
    shell习题第20题:统计文件大小
    萌新小白
    编程第一天
    萌新报道
    linux下安装php扩展pdo_oci和oci8
    安装Hadoop伪分布式踩过的坑
    zabbix安装过程
    MySQL_索引
    mysql复制
  • 原文地址:https://www.cnblogs.com/bro-ma/p/9085832.html
Copyright © 2011-2022 走看看