• 写代码的时候应该想到的问题

    代码好坏体现了个人以及公司对代码的准入标准, 标准越高, 对个人能力的提升也越大
    这篇文章主要介绍自己在编写代码时想到的问题, 供大家交流参考

    1. 代码最终要给其它成员review, 所以commit时, 请把属于同一类的改动, 放到同一个commit下, 把不相关的改动, 放到别的commit下, 方便别人review 以及理解你的逻辑.
      2.commit message 必须写到清清楚楚, 通常就三段
      第一段: 简要介绍, 本次改动的类别, feat, style, doc, build ..., 以及简介
      第二段: 介绍为啥要做这个改动
      第三段: 请把你的需求单链接贴出来, 比如JIRA的链接
      写清楚和详细的目的就是方便以后大家回滚代码或者review你的代码时, 保证准确.
      3.push前, 请rebase master, 再push -f, 这样保证master是清晰的

    以上是讲开发流程的, 下面说代码
    写代码跟装修房子很多是相通的
    1.明确职责
    每个变量

    a) 可见范围 - 你的变量是用来干嘛的, 需要公开, 私有,还是只给子类用?

    b) 职责 - 你的变量名跟它的职责有关系吗?有的话,是对应的吗,命名是否合理, 这个变量是不是只跟一个功能有关?

    c) 复用 - 你的变量应该是类级别的,还是实例级别的,应该被共享出来吗, 有没有其它库已经提供了类似变量,有必要定义这个变量吗?

    每行代码

    a) 你的这行代码是用来干嘛的, 是不是只做了一件事

    b) 这行代码是否要在不同代码中共享

    c) 有没有已经实现了类似功能的代码

    每个函数

    a) 职责 - 只做一件事

    b) 复用 - 需要共享吗, 能用别人实现的东西吗?

    c) 开闭 - 改动容易吗? 是不是开闭? hard code的代码能不能挪到配置文件里去?

    d) 测试 - 容易写单元测试吗? 能不能测试

    e) 异常 - 需要抛异常吗, 抛checked还是unchecked, 遇到异常需要处理吗, 是简单的记下log, 还是自己处理掉, 还是想封装下异常再抛, 还是啥都不管,让上一级帮我们处理? 为什么要这样做?

    f) 日志 - 有需要打debug日志的地方吗? 有需要打error的地方吗? 日志级别, 日志格式, 日志的内容是不是有意义的? 你得保证维护的人看到日志就知道是啥意思

    每个类

    a) 是否职责单一

    b) 是否可以复用, 是否复用别人

    c) 是否开闭

    d) 是否可测试, 容易测试

    e) 异常处理的是否合理

    f) 日志打的是否合理

    每个package

    每个project

    相关文章
    相关标签/搜索
    管家婆精选八码中特蓝月亮 勃利县| 昌邑市| 桐庐县| 明水县| 遵化市| 东阿县| 东莞市| 万盛区| 淄博市| 江川县| 澄城县| 紫金县| 沅江市| 资兴市| 新宾| 股票| 崇文区| 临夏县| 松江区| 常德市| 灵台县| 银川市| 辽宁省| 岫岩| 汪清县| 大足县| 项城市| 高清| 绿春县| 横峰县| 资讯| 聂荣县| 铁力市| 桐梓县| 顺平县| 浦东新区| 博湖县| 嵊州市| 邵阳县| 林芝县| 图木舒克市| 信丰县| 安丘市| 贺州市| 沁水县| 昌宁县| 怀宁县| 墨竹工卡县| 顺平县| 石狮市| 龙川县| 兴宁市| 茌平县| 漯河市| 永新县| 桓台县| 山西省| 玛纳斯县| 青冈县| 科技| 石首市| 固原市| 崇义县| 石河子市| 福鼎市| 化州市| 凤冈县| 宽城| 仪征市| 平潭县| 青冈县| 崇信县| 攀枝花市| 邢台市| 景宁| 施秉县| 安远县| 科技| 驻马店市| 九江市| 凌云县| 革吉县| 江津市| 浠水县| 宿州市| 公主岭市| 荣成市| 饶阳县| 夏邑县| 临洮县| 阳谷县| 香格里拉县| 宁阳县| 祥云县| 丰原市| 临西县| 察哈| 和顺县| 互助| 桐乡市| 磴口县| 横山县| 永兴县| 通化县| 班玛县| 汽车| 若尔盖县| 博白县| 静宁县| 莫力| 高密市| 贵阳市| 炉霍县| 长沙市| 莱西市| 延津县| 贵港市| 浦县| 邹城市| 灯塔市| 衡山县| 内丘县| 临沂市| 雷山县| 台东县| 介休市| 瓦房店市| 玛多县| 岫岩| 原平市| 龙胜| 江西省| 灌南县| 南汇区| 丰都县| 徐汇区| 苍溪县| 鄂尔多斯市| 临泽县| 台中市| 东乡县| 昌邑市| 咸宁市| 固原市| 黔西县| 永城市| 金坛市| 张掖市| 隆昌县| 衡东县| 德庆县| 临西县| 台南县| 永安市| 龙陵县| 锡林郭勒盟| 辰溪县| 诏安县| 惠东县| 武鸣县| 临湘市| 葫芦岛市| 怀仁县| 巩留县| 琼结县| 炎陵县| 社会| 江源县| 惠水县| 贵德县| 偏关县| 巴彦县| 隆回县| 韶山市| 绩溪县| 额济纳旗| 新竹市| 恭城| 兰溪市| 茌平县| 博野县| 武冈市| 河间市| 沈丘县| 贵定县| 平定县| 青铜峡市| 大兴区| 广宗县| 朔州市| 万荣县| 子洲县| 腾冲县| 吴川市| 沂源县| 喀喇沁旗| 翁源县| 固镇县| 汽车| 高台县| 兴城市| 枝江市| 百色市| 临西县| 济宁市| 江川县| 瑞丽市| 鲁山县| 清流县| 廊坊市| 花莲县| 汉寿县| 邢台市| 酒泉市| 江西省| 清涧县| 柘荣县| 罗平县| 长治县| 长子县| 安国市| 泊头市| 泽普县| 林芝县| 肇州县| 阿巴嘎旗| 赤壁市| 武汉市| 旌德县| 静海县| 萨嘎县| 嘉兴市| 城固县| 厦门市| 云南省| 通河县| 高淳县| 永春县| 镇江市| 海城市| 扎赉特旗| 库车县| 兴仁县| 淅川县| 普兰店市| 共和县| 中方县| 黄龙县| 五河县| 盐源县| 荣成市| 专栏| 大邑县| 镇原县| 澄城县| 吐鲁番市| 邢台县| 南和县| 恭城| 内丘县| 卓尼县| 宾阳县| 磐石市| 太白县| 水富县| 天镇县| 平度市| 新龙县| 沁源县| 平潭县| 建阳市| 安阳市| 凤冈县| 招远市| 东海县| 扶沟县| 高邮市| 涿鹿县| 五华县| 盐城市| 张掖市| 永丰县| 神木县| 河西区| 鄂尔多斯市| 墨脱县| 都兰县| 石屏县| 惠来县| 潼关县| 武胜县| 襄樊市| 海盐县| 泾川县| 曲阜市| 南汇区| 茶陵县| 阿勒泰市| 呼伦贝尔市| 柯坪县| 诸暨市| 商丘市| 吴旗县| 嘉定区| 永康市| 浦东新区| 禄丰县| 泰和县| 台北市| 江山市| 改则县| 鹰潭市| 镇巴县| 景德镇市| 保山市| 太保市| 同江市| 个旧市| 锡林郭勒盟| 阳江市| 威远县| 郯城县| 肥东县| 芷江| 徐州市| 娱乐| 林口县| 论坛| 塔河县| 马关县| 静海县| 荔浦县| 久治县| 临城县| 上犹县| 桂东县| 丹棱县| 横山县| 镇原县| 桂平市| 焦作市| 临邑县| 江源县| 大姚县| 虹口区| 虹口区| 通山县| 蛟河市| 平南县| 东乌珠穆沁旗| 凤山市| 随州市| 襄垣县| 保靖县| 蓝山县| 阳泉市| 东安县| 贵港市| 内乡县| 昭觉县| 东平县| 金乡县| 洪江市| 樟树市| 安丘市| 桐城市| 河西区| 犍为县| 阿鲁科尔沁旗| 行唐县| 玉环县| 南部县| 乳源| 蓬安县| 麻江县| 元朗区| 琼中| 大英县| 萨迦县| 平江县| 卢氏县| 沾化县| 白山市| 沙洋县| 内丘县| 通江县| 民县| 普格县| 井陉县| 揭阳市| 嘉义市| 淮安市| 巴东县| 韶山市| 桂林市| 会同县| 大悟县| 安乡县| 怀宁县| 成武县| 南开区| 凌云县| 南通市| 禄劝| 宿州市| 施秉县| 鄂伦春自治旗| 盐边县| 铜川市| 吉木乃县| 芷江| 城口县| 海口市| 建水县| 麟游县| 贵州省| 安乡县| 吉安市| 虎林市| 彰化县| 广南县| 田林县| 新巴尔虎右旗| 蒲江县| 长海县| 东乡族自治县| 济南市| 兴宁市| 华阴市| 西贡区| 右玉县| 曲阳县| 阳泉市| 磴口县| 杭锦旗| 大连市| 静乐县| 河间市| 察隅县| 全南县| 荔波县| 长丰县| 宝坻区| 新安县| 汶川县| 出国| 禄劝| 富川| 宜君县| 克东县| 黄浦区| 江源县| 成安县| 英吉沙县| 鄢陵县| 全椒县| 科技| 宝兴县| 青田县| 印江| 东台市| 巴马| 花莲县| 湖南省| 岐山县| 东辽县| 乐至县| 高阳县| 定兴县| 永昌县| 读书| 芦山县| 金乡县| 扶风县| 和平县| 稷山县| 吴桥县| 新龙县| 静安区| 景洪市| 辽源市| 抚宁县| 梨树县| 修武县| 平果县| 绥江县| 黄平县| 泸定县| 秦安县| 新竹县| 商南县| 谢通门县| 青神县| 平果县| 蒙城县| 乌审旗| 吉隆县| 桐庐县| 临夏县| 万载县| 腾冲县| 观塘区| 星座| 佛教| 陕西省| 乌鲁木齐县| 永新县| 五莲县| 东丰县| 新闻| 如东县| 定州市| 且末县| 惠州市| 大连市| 黄平县| 武平县| 富源县| 文化| 彩票| 肃南| 繁峙县| 光泽县| 同江市| 武邑县| 基隆市| 永吉县| 庄河市| 大石桥市| 平山县| 渝中区| 金乡县| 泗阳县| 巍山| 海安县| 天峻县| 贵溪市| 武隆县| 延川县| 吉木萨尔县| 新乡县| 独山县| 晴隆县| 错那县| 蓬安县| 边坝县| 乐至县| 吴川市| 高密市| 平顶山市| 友谊县| 凉城县| 灵台县| 鹤峰县| 泸水县| 黑龙江省| 清水县| 南京市| 沙洋县| 浦北县| 湾仔区| 青冈县| 准格尔旗| 大同县| 定结县| 梓潼县| 青阳县| 白银市| 孝昌县| 历史| 东海县| 区。| 甘南县| 扶绥县| 尤溪县| 吴旗县| 和龙市| 林州市| 绥德县| 喀喇沁旗| 休宁县| 永康市| 海伦市| 松江区| 杭锦旗| 杭锦后旗| 佛教| 屯昌县| 灌云县| 新营市| 苍南县| 靖边县| 交城县| 田阳县| 射洪县| 黑山县| 嘉鱼县| 泸州市| 凤冈县| 甘德县| 康乐县| 吐鲁番市| 宜兰县| 晴隆县| 吉首市| 芜湖市| 卓资县| 广南县| 利津县| 太保市| 象州县| 广西| 东丰县| 武胜县| 怀安县| http://wap.jxcgqc.fit http://wap.txqewq.fit http://m.rdpqdm.fit http://jmpknw.fit http://www.uvdlwj.fit http://phbxxz.fit http://www.mtwxxt.fit http://www.atsapr.fit http://m.erselg.fit http://www.owvtgd.fit http://m.bctcgm.fit http://m.pxsoyy.fit http://m.shtugf.fit http://www.dsfkhh.fit http://m.yaxerr.fit http://m.rturgo.fit http://m.jiuptz.fit http://www.saueqr.fit