总结代码整洁之道

MIL图像处理那些事:MIL的安装和MIL工具箱 MIL图像处理那些事:MIL的安装和测试,如何用C#使用MIL 阅读详情

注释

不恰当的信息

        注释只应该描述有关代码和设计的技术性信息

废弃的注释

        如果发现废弃的注释,最好尽快更新或删除,废弃的注释会远离它们曾经描述的代码,变成代码中无关和误导读者的浮岛。

冗余注释

        如果注释描述的是某种充分自我描述了的东西,那么注释就是多余的

糟糕的注释

        字斟句酌使用正确的语法和拼写,别闲扯,别画蛇添足,保持简洁

注释掉的代码

        删除它!别担心源代码控制系统还会记得它。

环境

构建系统应该是单步的小操作,不应该从源代码控制系统中一小点一小点的迁出代码。应该能够使用单个命令迁移出来,并使用单个命令构建

函数

避免过多的参数

        3个以上的参数非常值得质疑,应坚决避免。

输出参数

输出参数违反直觉,因为读者期望参数用于输入而非输出。如果函数非要修改什么东西的状态,就修改它所在对象的状态就好了。

标识参数

布尔值参数大声宣告函数做了不止一件事,令人迷惑应该删除。

死函数

永远不被调用的函数应该被删除。

一般性问题

一个源文件存在多种语言

        理想的源文件包括且只包括一种语言。现实可能会不得不使用多种,应该尽力缩小额外语言的数量和范围。

明显的行为未被实现

不正确的边界行为

        别依赖直觉理解代码,追索每一种边界条件,并编写测试

忽视安全

        关闭失败测试、告诉自己过后再处理具有非常大的安全隐患

重复

信息过多

        设计良好的模块有着非常小的接口,让你事半功倍。低劣的接口拥有大龄必须调用的函数,耦合度非常高。

死代码

垂直分隔

        变量和函数应该在就近被使用的地方定义。

函数名称应该表达其行为

学习算法

        不要无脑塞一大堆的if和for,让系统勉强工作。

遵循标准约定

        每个团队都应该遵循基于通用行业规范的一套编码标准。

函数只做一件事

在较高层级放置可配置数据

名称

采用描述性名称

名称应该与抽象层级相符

尽可能使用标准命名法

无歧义的命名

为较大作用范围选择较长的名称

避免编码

【运动规划算法项目实战】如何使用Pure Pursuit算法进行路径跟踪(附ROS C++代码) 在自动驾驶和机器人导航领域,路径跟踪是一项关键技术,它使车辆或机器人能够按照预定的路径规划进行移动。路径跟踪算法的选择对于系统性能和安全性至关重要。本文将介绍一种常用且有效的路径跟踪算法——Pure Pursuit算法。我们将详细讨论Pure Pursuit算法的原理、实现步骤以及如何在自动驾驶和机器人系统中应用该算法进行路径跟踪。Pure Pursuit是一种用于路径跟踪的控制算法。它通过计算角速度控制机器人从当前位置移到机器人前方的某个预瞄点。假定线速度是恒定的,当然可以随意更改机器人的线速度。 阅读详情

相关推荐

3D视觉-结构光测量-线结构光测量

线结构光测量中,由激光器射出的激光光束透过柱面透镜扩束,再经过准直,产生一束片状光。这片光束像刀刃一样横切在待测物体表面,因此线结构光法又被成为光切法。线结构光测量常采用二维面阵CCD作为接受器件,因此只要通过增加垂直于面阵探测器的第三维度方向,就可以实现对三维物体的测量。

qq_20660115的博客 3137

代码整洁之道

谈谈代码整洁之道、重构

程序大视界 5687

Ribo-seq数据解析:从翻译效率计算到动态可视化分析

本文系统介绍了Ribo-seq(核糖体印迹测序)数据分析全流程,从核心的P-site定位、翻译效率计算,到差异翻译分析和动态可视化。重点阐述了如何利用Ribo-seq高分辨率数据揭示基因表达在翻译层面的精细调控,并提供了从数据处理到生物学解读的实用工具与避坑指南。

weixin_28559803的博客 422

代码整洁之道总结

前言 什么是整洁的代码 出自《c++程序设计语言》作者说到 我喜欢优雅和高效的代码。代码逻辑应当直截了当,叫缺陷难以隐藏;尽量减少依赖关系,使之便于维护;依据某种分层战略完善错误处理代码;性能调至最优,省得引诱别人做没规矩的优化,搞出一堆混乱来。整洁的代码只做妤一件事 OTI公司创始人,Eclipse 战略教父,Dave Thomas说到: 整洁的代码应可由作者之外的开发者阅读和增补。它应通过所有单元测试和验收测试。它使用有意义的命名。它只提供一种非多种做一件事的途径。它只有尽量少的依赖关系、

代码缔造者的博客 5090

解忧杂货铺(四):Hightec生成HEX方法+小功能开启

Hightec使用的一些常用技能

梦想技术家 2162

【首份】2023年30米分辨率土地利用遥感监测数据

为了恢复和重建我国土地利用变化的现代过程,更好地预测、预报土地利用变化趋势,地球资源数据云以美国陆地卫星Landsat 遥感影像数据作为主信息源,结合Sentinel系列数据,通过人工目视解译和机器学习方法,建立了国家尺度1:10 万比例尺多时期土地利用/土地覆盖遥感监测数据库(CNLUCC)因早期Landsat数据时空覆盖缺失,1972-1977年合成第一期数据,1978-1985年合成第二期数据,1986年起每年度生成一期数据。投影:Albers正轴等面积双标准纬线圆锥投影南标准纬线:25°N。

地球资源数据云的官方博客 3690

代码简洁之道(译)

相同类型的变量使用相同的词 Bad: Good: 使用可搜索/定位的名称 Bad: Good: 使用解释性变量 Bad: Good: 避免隐式映射 Bad: Good: 不要添加不需要的内容 Bad: Good: 使用默认参数,而不是判断或条件 默认参数通常更简洁。请注意,如果使用它们,函数只会为未定义的参数提供默认值。其他“假”值,如“,”,false, null, 0和NaN,将不会被默认值替换。 Bad: Good: 函数 函数参数(理想情况下2个或更少) 限制函数参数的数量是非...

goodloving的博客 2642

[捷稀 JCG Q30 Pro 刷机说明] 以刷入openwrt24.10为例

摘要: 本文详细介绍了捷稀JCG Q30 Pro路由器刷入OpenWrt 24.10系统的步骤。通过先刷入OpenWrt 23.05过渡固件,再升级Uboot,最后通过TFTP加载工厂镜像完成刷机。关键步骤包括解锁分区、刷写Uboot、进入恢复模式及配置网络。文章还提供了无线设置、Tailscale内网穿透等进阶命令,并附参考文档和固件下载链接。适用于有一定技术基础的玩家,需注意操作风险,严格按流程执行。

贤时间 7162

《代码整洁之道》

本文,摘录一下《代码整洁之道》这本书,最让我印象深刻的片段。 一,整洁代码 1,什么是整洁代码 ————————————书本第6页————————————待补充图片 z这里提到了2个关键词:优雅,高效。 优雅就不说了,现在讨论整洁代码的时候,大家都会提到这个词,代码是一种艺术。 高效,这个观点还挺有意思的,尤其是这句: 性能调至最优,省得引诱别人做没规矩的优化,搞出一堆混乱来。 二,有意义的命名 1,名副其实 我理解这个和代码自注释意思差不多,当命名做的好,就不需要注释。 ..

nameofcsdn的博客 5749

RK3588 buildroot 双网口bonding调试

本文介绍了Rockchip Buildroot中配置网络冗余的方法,通过bonding技术将多个物理网口合并为逻辑接口。主要内容包括:1)7种常见bonding模式的特点及适用场景;2)RK3588的具体配置流程,包括内核配置(启用bonding驱动、修改dts)、添加ifenslave工具;3)系统编译和网络状态检查。

501846585_QQAndroid_java 460

GStreamer Plugin之Gst-nvdewarper

支持三种投影类型 NVDS_META_SURFACE_FISH_PUSHBROOM, NVDS_META_SURFACE_FISH_VERTCYL 和NVDS_META_SURFACE_PERSPECTIVE_PERSPECTIVE。关于每个平面的NvDewarperSurfaceMeta参数(projection_type, surface_index, and source_id)以及内存中有效的矫正平面(num_filled_surfaces)包含RGBA格式的一帧的缓存。矫正后的RGBA格式。

pvmsmfchcs的博客 368

【《代码整洁之道》精读与演绎】之一 让代码比你来时更干净

“我们就是一群代码猴子,上蹿下跳,自以为领略了编程的真谛。可惜当我们抓着几个酸桃子,得意洋洋坐到树枝上,却对自己造成的混乱熟视无睹。那堆“可以运行”的乱麻程序,就在我们的眼皮底下慢慢腐坏。” ——《代码整洁之道》作者 RobertC.Martin,于SD West 2007技术大会 一、系列文章前言 敲完上面这段文字的时候,心里在想,一个刚踏入编程生涯的新人,要经历多少的淬炼,才能领略到Bob大叔所谓的编程的真谛。 有人说,这个过程会很漫长,大概至少是在读完N本编程领域的经

【浅墨的游戏编程Blog】毛星云(浅墨)的专栏 2万+

Simulink仿真入门到精通(三) Simulink信号

本系列教程是根据孙忠潇编著的<<Simulink仿真及代码生成技术入门到精通>>学习笔记。 目录 Simulink仿真入门到精通(一) Simulink界面介绍 Simulink仿真入门到精通(二) Simulink模块 Simulink仿真入门到精通(三) Simulink信号 Simulink仿真入门到精通(四) Simulink子系统 Simulink仿真入门到精通(五) Simulink模型的仿真 Simulink仿真入门到精通(六) Simulink模型保存为图片 Sim

king110108的专栏 5398

【《代码整洁之道》精读与演绎】之三 整洁代码的函数书写准则

这篇文章,是关于整洁代码函数书写的一些准则。 一、引言以下引言的内容,有必要伴随这个系列的每一次更新,这次也不例外。 《代码整洁之道》这本书提出了一个观点:代码质量与其整洁度成正比,干净的代码,既在质量上可靠,也为后期维护、升级奠定了良好基础。书中介绍的规则均来自作者多年的实践经验,涵盖从命名到重构的多个编程方面,虽为一“家”之言,然诚有可资借鉴的价值。 但我们知道,很多时候,理想很丰满,现实很骨

【浅墨的游戏编程Blog】毛星云(浅墨)的专栏 1万+

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

Devexpress16.2.6破解工具

Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具Devexpress16.2.6破解工具

代码之美——代码整洁之道

代码之美有很多方面,可以谈高级编程语言以及各语言的框架/类库,也可以聊算法和数据结构,还可以谈操作系统内核或是层出不穷的中间件,不过这里我们看最不起眼的代码整洁之道。

京东零售技术的博客 2875

假人有限元模型

假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用

读《代码整洁之道》有感

在工作中遇到烂代码的可能性是 100%,即使是很厉害的大佬写的代码,在不知情的情况下让你去看,看了一会后都会得出以下结论:“写的啥玩意啊,看都看不懂,乱七八糟的语法糖,考虑过后面工作的人么?当然很多人会说:“项目中的屎山代码,我能在上面雕花已经很厉害了,还要干什么,即使我知道那块写的不好,但我也不会去动,因为现在它处于一个稳定的状态,如果我去修改了之后,出了问题全是自己背,吃力不讨好!”这也确实是很多人的现状,考虑的也不无道理,但在这里咱们单纯从代码的角度来看,从写代码的初心来看,早早的就背道而驰了。

Zhujiang 1342

IDEA的使用指南

IDEA基于java的使用手册,可以最快速的上手,在使用中不断的丰富自己的使用技巧.

Java代码整洁之道

Java代码整洁之道,介绍了什么是好代码,从命名规范、包整洁、类整洁、函数征集、异常征集、注释征集等几个方面介绍了怎么写好Java代码。

大前端程序员的自我修养 2753

代码之美-代码整洁之道

可能有人觉得谈代码太基础,有点low,不够高大上,应该谈谈设计、模型、算法,亦或是业务域;或者也有人觉得随着AI技术发展,代码可以自动生成了;我也曾一度觉得代码包括整洁代码,对于以此为生的专业人士,应该人人已经掌握。现实的世界却是啪啪地打脸,我们的注册应用系统数量以万记,没听说一个系统的代码是靠AI自动生成,而每个月的故障汇总中都有代码引起的问题,要解决这些基础问题,还是要从基础说起。

京东科技开发者 905

代码整洁之道详解

此外,还有一系列与执行、调度和取消异步任务相关的方法,如`schedule`, `post`, `execute`, `start`, `cancel`, `stop`等,以及与事件回调相关的方法,如`onCompleted`, `beforeUpdate`, `preUpdate`, `willUpdate`, `afterUpdate`, `postUpdate`, `didUpdate`和`should`等。所以,很重要的一点,你需要能精确的用代码表达出你的思想,让其他人通过代码能明白你的意图。

专注于前沿技术的探索与实践,热衷于从代码逻辑、架构设计到行业应用等多维度深挖技术本质。期待在技术之路上与你共同成长~ 1120

代码整洁之道培训总结

作者:翁松秀 代码整洁之道培训总结 1. 本次培训的总结 1.1培训目的 人类行为都是以目的为导向,培训也是。 这次培训目的很明确,就是让我们的代码更加简洁。为了实现这个目的,我们需要搞明白三个问题: 什么是整洁的代码? 为什么要让代码简洁? 怎么让代码简洁? 这次培训围绕这三个问题,从思想、函数、重构、设计和工具五个方面讲解代码的简洁之道,最后只为了实现一个目的,也就是本次培训的意义:让我...

Mr.Write的博客 1284

《代码整洁之道》全书归纳

重构通常始于发现代码中的问题迹象,即“代码异味”。这些异味是代码中可能存在更深层次设计问题的表面特征。学会识别这些异味是重构的第一步。

CoFFee________的博客 1111

代码整洁之道简单总结

代码整洁之道》(Clean Code)是由 Robert C. Martin(Bob 大叔)编写的一本关于如何编写高质量代码的经典著作。这本书强调了编写整洁、可读、可维护代码的重要性,并提供了大量实用的建议和原则。Bjarne Stroustrup(C++ 之父):优雅且高效;逻辑直接了当;尽量减少依赖关系;错误处理完全明确;性能接近最优。Grady Booch(UML 创始人之一):简单直接地表达设计思想;看起来不重要,但其实至关重要。Dave Thomas(《程序员修炼之道》作者)

weixin_38472038的博客 934

代码整洁之道-读书笔记

代码整洁之道-读书笔记 文章目录代码整洁之道-读书笔记有意义的命名-高质量代码的命名法则1 名副其实2 避免造成误导3 尽量做有意义的区分4 尽量使用读得出来的名称5 尽量使用可搜索的名称6 取名不要绕弯子7 类名尽量用名词**8 方法名尽量用动词**9 每个概念对应一词,并一以贯之10 通俗易懂11 尽情使用解决方案领域**专业术语**12 添加有意义的语境13 避免使用编码14 小结函数书写准则1.短小2.单一职责 只做一件事3.函数参数尽可能的少4.分隔指令与询问5.使用异常替代返回错误码6.别重复自

阿常呓语的专栏 1680

《代码整洁之道》:5大基本要点

全文共3257字,预计学习时长10分钟来源:Pexels评论区常常有小伙伴推荐罗伯特·C·马丁的《代码整洁之道(Clean Code)》。今天我们就来了解一下这本书,它值不值得一看?关...

读芯术的博客 1264

Clean Code 代码整洁之道

一直想深入看看《CleanCode 代码整洁之道》,增强代码整洁性。看到此文,略有启发,转载以敬之。 作者:JobsandCzj 来源:优快云 原文:https://blog.youkuaiyun.com/jobsandczj/article/details/81369970 版权声明:本文为博主原创文章,转载请附上博文链接! --------------------- 一本非常经典的书,读了...

zhang123bl的博客 1388
上一篇: -了解并发
下一篇: 逐步改进代码
Coder_Chang
博客等级 码龄11年 82粉丝 81原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值