clean code 与编码规范

上周给team做了关于cleancode的workshop。有同事问我,cleancode是不是就是编码规范。我说当然不是了。

要写出cleancode,我认为要从下面几个方面入手:

  • 代码的微观方面,比如要有好的naming、代码的自注释性、足够小的函数等
  • 宏观的代码结构,包括设计原则(SOLID设计原则等),设计模式等
  • 人与代码的关系,如TDD、ATDD。。。
  • 软件过程中的人与人的关系,比较scrum提倡的一些activity

当然Uncle Bob的cleancode主要在前三个点进行了描述。

说回编码规范,其实cleancode并没有明确定义编码规范。个人认为编码规范是一个team写代码的共同约定,而且应该是个动态的东西,随着技术的进步和team的成熟而不断变化。

如果team使用的编码环境(工具)比较智能,对应编码格式的要求就可以比较少;如果team的编码能力比较强,编码规范就可以比较有弹性。而且随着team的成熟,编码规范也要不断更新,剔除些比较‘死’的条条框框。

时间: 2024-10-05 20:34:23

clean code 与编码规范的相关文章

Python PEP8 编码规范中文版-译自官网文件

写在前面(自补):初听PEP8一头雾水,不知所谓.啥是PEP8?为啥叫PEP8?PEP8是干啥的?-先了解下PEP吧. PEP是什么? PEP的全称是Python Enhancement Proposals,其中Enhancement是增强改进的意思,Proposals则可译为提案或建议书,所以合起来,比较常见的翻译是Python增强提案或Python改进建议书. 我个人倾向于前一个翻译,因为它更贴切.Python核心开发者主要通过邮件列表讨论问题.提议.计划等,PEP通常是汇总了多方信息,经过

编码规范系列(一):Eclipse Code Templates设置

http://chenzhou123520.iteye.com/blog/1625629 从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面).所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格.主要包括三个方面:设置Code Templates.Eclipse formatter.Checkstyl

Java Script 编码规范

Java Script 编码规范 以下文档大多来自: Google JavaScript 编码规范指南 Idiomatic 风格 参考规范 ECMAScript 5.1 注解版 EcmaScript 语言规范, 5.1 版 基本原则: 无论有多少人在维护,所有在代码仓库中的代码理应看起来像同一个人写的. 前言 下面的章节描述的是一个 合理 的现代 JavaScript 开发风格指南,并非硬性规定.其想送出的核心理念是高度统一的代码风格(the law of code style consiste

Eclipse_Java编码规范详细设置

转载请注明来源:http://blog.csdn.net/u010194538/article/details/51167563 软件项目质量保证----编码规范. 一个公司团队有个编码规范是必须的,大部分公司的都一样,但每个不同的公司有一些特殊的要求. 编码规范的作用 提高可读性:有助于知识传递,加快工作交接 :统一全局,促进团队协作:减少名字增生,降低维护成本:强调变量之间的关系,降低缺陷引人的机会:提高程序员的个人能力 Eclipse开发样式 这里主要先从Eclipse工具说下: 设置工作

《clean code》讲述代码中的道,而不是术

Clean code 看<clean code>一书,学习高手写出的代码,简单高效的代 1.目标 Bjarne Stroustrup:优雅且高效:直截了当:减少依赖:只做好一件事 Grady booch:简单直接 Dave thomas:可读,可维护,单元测试 Ron Jeffries:不要重复.单一职责,表达力(Expressiveness) 代码的书写,一定程度上体现了编程的思想,编码者的功力,标识出红色的部分我觉得体现了函数式编程,面向对象的思想,需要细细体会 2 命名 2.1 前期统一

我也学php:编码规范/翻译自PSR

PHP社区百花齐放,拥有大量的函数库.框架和组件.PHP开发者通常会在自己的项目中使用若干个外部库,因而PHP代码遵循或尽量接近同一个代码风格就非常重要,可以让开发者方便地把多个代码库集成在自己的项目中. 框架互操作组(即PHP标准组)发布了一系列代码风格推荐标准,即PSR-0,PSR-1,PSR-2和PSR-3. 不要让这些名称所混淆,这些推荐仅是一些被其它项目所遵循的规则,如Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Li

html编码规范

不久前接到老大下达的任务,要拟定一份公司前端编码规范的草稿,参考了各大公司的编码规范,结合现在公司的特点,整理出以下编码规范: html规范 1 文件相关 (1) 文件名以英文为主,可以使用下划线(如active.html),压缩包以项目名+日期的形式. (2) 统一使用utf-8编码. (3) css.js发布到线上都需要压缩. (4) 在追求高度优化的站点,需要对图片也进行无损压缩. 2 代码风格 2.1 命名 (1) 元素 id 必须保证页面唯一.(解释:同一个页面中,不同的元素包含相同的

iOS:Cocoa编码规范 -[译]Coding Guidelines for Cocoa

--原文地址:https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/FrameworkImpl.html Cocoa编码规范 --前言 用公共API开发一个Cocoa框架,插件,或其他可执行目标,里面的命名编写和规范不同于一般应用程序的开发.因为你开发出来东西是给开发者用的看的,并且他们不熟悉你的编程接口.这个时候API的命名约定就派上用场了,因为它使你的写

web项目开发 之 前端规范 --- JavaScript编码规范

JavaScript编码规范 此文严格按照W3C规范和部分实际项目可读性,浏览器加载,性能等众多属性权衡,做出平时前端编码规范文档.供广大web工作者参考并实施,对维护和项目扩展升级都能省时省力. 场景:web前端开发中 一些Javascript的注意事项 和 规格建议: [参考百度资料 和个人一些总结] 1 前言 JavaScript 在百度一直有着广泛的应用,特别是在浏览器端的行为管理.本文档的目标是使 JavaScript 代码风格保持一致,容易被理解和被维护. 虽然本文档是针对 Java