小鲸鱼软件小鲸鱼软件
首页
  • 概览
  • Git工作流说明
  • HTML代码风格
  • VUE 代码风格
  • 代码防腐
  • 离站链接风险提示页的简单实现
  • 使用docker-compose部署ElasticSearch
  • 代码仓库

    • Gogs
    • Gitea
    • Gitlab
  • CI/CD

    • Jenkins
  • 辅助工具

    • 禅道
    • Harbor
    • Nexus
    • Rancher
    • Grafana
    • Kibana
    • Portainer
  • GitlabPages

    • Nuxt中文文档
    • VuePress Docs
    • Nuxt Demo
    • Mkdocs Demo
    • Hexo Demo
  • 图像工具

    • 图片在线编辑
    • 二维码生成器
    • SVG生成器
  • 格式转换

    • 日期格式转换
    • 颜色格式转换
    • Yaml转json
    • Toml转json
    • Json转yaml
    • Json转toml
    • Yaml转toml
    • Toml转yaml
    • 罗马数字转换
  • 加解密

    • 密码强度分析
    • MD5/Hash
    • 对称加解密
    • Base64字符串
    • Base64文件
    • Token生成器
    • UUID生成器
    • BIP39密码短语生成器
    • HMAC生成器
    • RSA密钥对生成器
  • 数学

    • 表达式求值
    • 预计到达时间
    • 百分比计算器
  • 开发者

    • UA解析
    • Json对比
    • Json格式化
    • Json去格式
    • SQL格式化
    • Xml格式化
    • Chmod权限计算
    • Docker命令转换
  • 网络

    • IPv4子网计算
    • IPv4地址转换
    • CIDR计算
    • MAC地址解析
    • IPv6 ULA生成器
  • 能接什么项目
  • 软件定制

    • Android/iOS客户端
    • 多端互动类应用
    • 各类工控上位机软件
    • 各类自动化辅助软件
  • DevOps

    • DevOps工具托管
    • DevOps账号租用
  • 二次开发

    • Scratch
    • 办公软件
    • Udp/Tcp工具
    • 远程控制
    • 串口通信
  • 项目搭建

    • ElasticSearch集群
    • Kubernetes集群
    • Harbor
    • 邮件系统
    • DNS私服
  • 怀旧

    • 飞机大战
    • 魔方游戏
  • 我们

    • 关于我们
    • 联系我们
  • 简体中文
  • English
首页
  • 概览
  • Git工作流说明
  • HTML代码风格
  • VUE 代码风格
  • 代码防腐
  • 离站链接风险提示页的简单实现
  • 使用docker-compose部署ElasticSearch
  • 代码仓库

    • Gogs
    • Gitea
    • Gitlab
  • CI/CD

    • Jenkins
  • 辅助工具

    • 禅道
    • Harbor
    • Nexus
    • Rancher
    • Grafana
    • Kibana
    • Portainer
  • GitlabPages

    • Nuxt中文文档
    • VuePress Docs
    • Nuxt Demo
    • Mkdocs Demo
    • Hexo Demo
  • 图像工具

    • 图片在线编辑
    • 二维码生成器
    • SVG生成器
  • 格式转换

    • 日期格式转换
    • 颜色格式转换
    • Yaml转json
    • Toml转json
    • Json转yaml
    • Json转toml
    • Yaml转toml
    • Toml转yaml
    • 罗马数字转换
  • 加解密

    • 密码强度分析
    • MD5/Hash
    • 对称加解密
    • Base64字符串
    • Base64文件
    • Token生成器
    • UUID生成器
    • BIP39密码短语生成器
    • HMAC生成器
    • RSA密钥对生成器
  • 数学

    • 表达式求值
    • 预计到达时间
    • 百分比计算器
  • 开发者

    • UA解析
    • Json对比
    • Json格式化
    • Json去格式
    • SQL格式化
    • Xml格式化
    • Chmod权限计算
    • Docker命令转换
  • 网络

    • IPv4子网计算
    • IPv4地址转换
    • CIDR计算
    • MAC地址解析
    • IPv6 ULA生成器
  • 能接什么项目
  • 软件定制

    • Android/iOS客户端
    • 多端互动类应用
    • 各类工控上位机软件
    • 各类自动化辅助软件
  • DevOps

    • DevOps工具托管
    • DevOps账号租用
  • 二次开发

    • Scratch
    • 办公软件
    • Udp/Tcp工具
    • 远程控制
    • 串口通信
  • 项目搭建

    • ElasticSearch集群
    • Kubernetes集群
    • Harbor
    • 邮件系统
    • DNS私服
  • 怀旧

    • 飞机大战
    • 魔方游戏
  • 我们

    • 关于我们
    • 联系我们
  • 简体中文
  • English

概览

规范不是为了约束和禁锢大家的创造力,而是为了帮助大家能够在正确的道路上,尽可能的避免踩坑和跑偏。 规范可以让我们无论单枪匹马还是与众人同行的时候都能得心应手。 规范可以让我们在面对日益变态的需求和做代码接盘侠的时候,更优雅从容。

规则并不是完美的,通过约束和禁止在特定情况下的特性,可能会对代码实现造成影响。 但是我们制定规则的目的:为了大多数程序员小伙伴可以得到更多的好处,如果在团队实际运作中认为某个规则无法遵循或有更好的做法,希望大家可以共同改进该规范。

开发规约

我们参考 Kent Beck 的简单设计四原则来指导我们的如何写出优秀的代码,如何有效地判断我们的代码是优秀的。

  • 通过所有测试(Passes its tests):强调的是外部需求,这是代码实现最重要的
  • 尽可能消除重复 (Minimizes duplication):代码的模块架构设计,保证代码的正交性,保证代码更容易修改
  • 尽可能清晰表达 (Maximizes clarity):代码的可阅读性,保证代码是容易阅读的
  • 更少代码元素 (Has fewer elements):保证代码是简洁的,在简洁和表达力之间,我们更看重表达力

以上四个原则的重要程度依次降低, 这组定义被称做简单设计原则。

设置开发规约的几个主要目标:

一、码出高效:标准统一,提升沟通效率和研发效能。

二、码出质量:防患未然,提升质量意识和系统可维护性,降低故障率。

三、码出情怀:工匠精神,追求极致的卓越精神,打磨精品代码。

开发规约从无到有,只是短期的目标;使大家遵守开发规约的成本极大降低,发布上线的应用符合开发规约是中期目标;而远期目标是从有到无,因为人人自觉遵守,规约和谐地融入代码的字里行间,规约似乎消失了,但又无处不在。

经验分享

分享,是一种追求精神满足的行为,一种自我实现

工作中分享经验是希望同事少走弯路,做事事半功倍,进而能认认真真思考,经验的分享对我们的工作和人生是很有帮助的。因为,能力的提升需要经常总结,盲无目的地工作是不行。总结才能完成积累,才能提高。同样也能把好的经验分享给大家,不好的给大家一个提醒,所以分享经验在工作中起到了很重要的作用。

活动
阿里云 最新优惠活动
上云必抢你先知,最新活动劲爆优惠不错过!


小鲸鱼软件开发 | © 2019-至今 | 京ICP备19009129号