美文网首页
代码之旅:基础规范

代码之旅:基础规范

作者: Jafeney | 来源:发表于2020-08-16 22:04 被阅读0次

在设计架构的时候,要考虑由下而上的模式,底层的实践最终会影响整个系统的架构。再好的架构,如果没有辅以有效的工程实践,那么最终我们得到的只是一只空有其表的架构方案。能自下而上影响软件架构的,就只有代码了。

代码本身是一种难以衡量的实践。同一个业务功能有不同的代码实现。想象一个场景,我们对外提供了一个 RESTful API 接口,是不是只要我们能以规范的方式提供这个RESTful API 接口,代码的实现方式和质量就变得不重要了?

从短期来看,如果一个API能快速地提供功能以驱动业务增长,那么它就就是一个成功的 API。不论其设计得多么丑陋,代码质量多差,只要不影响性能,未来就有改进的空间。可是从长期来看,API是要能够面向变化而快速拓展的,如果我们不能方便地在 API 中拓展功能,那么它就真的会影响业务了。尽管重构的代码可以帮助我们走向更好的架构,但是在业务进度不合理的情况下,我们只能在旧的、丑陋的代码上不断堆砌功能。直至有一天,我们愉快地选择重写系统。

在本节里,我们将讨论代码中的一些基础规范,他们更多地关注代码的可读性,而不是代码的质量,我们会在后面的章节里关注代码质量。为了提升代码的可读性,我们需要做到以下的几方面:

  • 规范代码组织结构
    • 统一代码风格,即源代码的书写风格
    • 组件、函数等命名规范
    • 开发工具规范

光看这几点要求,总觉得似乎多了很多条条框框。尽管这种统一性会扼杀团队的多样性,但是对于代码层次的风格统一是相当有必要的。

在这些实践中,有些并不仅仅是实践,他还反应了架构的模式,如代码组织结构 —— 从代码的组织构架上,我们可以真真切切地感受到他与系统架构的相似之处。由于应用内的代码复用采用组件化的架构,所以我们应该隔离不同的组件。比如,在 Angular 生成的组件 component 中,我们就可以看到一种组件完全独立的存在形式。

本文由博客一文多发平台 OpenWrite 发布!

相关文章

  • 代码之旅:基础规范

    在设计架构的时候,要考虑由下而上的模式,底层的实践最终会影响整个系统的架构。再好的架构,如果没有辅以有效的工程实践...

  • Java编码规范

    Java 代码规范 本 Java 代码规范以 SUN 的标准 Java 代码规范为基础,为适应我们公司的实际需要,...

  • PHP基础编码规范

    「PSR 规范」PSR-1 基础编码规范 基本代码规范 本篇规范制定了代码基本元素的相关标准,以确保共享的PHP代...

  • 应用开发部代码开发规范v1.1

    文档版本说明v1.0 基础版本v1.1 补充规范,增加规范等级 一、代码流程规范 (一) java代码处理 【强制...

  • PSR-1

    基本代码规范 本节我们将会讨论一些基本的代码规范问题,以此作为将来讨论更高级别的代码分享和技术互用的基础。 RFC...

  • Android编程基础---代码规范

    Author:ProZoom Hobby:爱折腾、爱思考,想静静的ProZoom Github --- 简书 ...

  • fidding编码规范之JS篇

    良好的编程规范是打造优秀代码的基础,以下是fidding个人编码规范整理,使用ECMAScript 6.0(ES6...

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • PSR-2-coding-style-guide

    PSR-2-coding-style-guide 代码风格指南 本手册是基础代码规范(PSR-1)的继承和扩展。 ...

  • Java代码的书写规范_每个程序必须要懂的

    本Java代码规范以SUN的标准Java代码规范为基础,为适应我们公司的实际需要,可能会做一些修改。本文档中没有说...

网友评论

      本文标题:代码之旅:基础规范

      本文链接:https://www.haomeiwen.com/subject/ddbxjktx.html