首页 > 其他分享 >《编写可读代码的艺术》总结与分享

《编写可读代码的艺术》总结与分享

时间:2023-10-11 23:14:29浏览次数:30  
标签:本书 变量名 概括 代码 注释 理解 编写 分享

《编写可读代码的艺术》

本书是一本帮助代码写的更好的书,本人阅读时间为国庆一周,读完觉得这本书很有意思,因此准备做个总结,但是厌烦了很多书的总结,枯燥乏味且罗里吧嗦,把书的目录和章节列出来,并且每个部分讲点就结束,实在是即浪费自己的时间也浪费别人的时间,因此本人尽量用精简和核心的话,去重新理解这本书。我决定用新的方式去理解这本书,每个章节、知识点都先用一句话去概括。

本书目的

一句话概括:本书的最终目的是如何写出让别人容易理解的代码。
(你是否看到别人的代码一头雾水,各种稀奇古怪的拆分,各种乱糟糟的函数体,一个方法中几百行,不断涌现的成员变量,各种地方的判空,寥寥无几的注释,我们无法改变别人,但是可以改变自己避免成为这样的人。)

本书结构

一句话概括:从外表(变量名、注释、排版)到内在(更容易理解的逻辑和结构)

1. 外表(变量名,注释,排版)

一句话概括:

  • 变量名需要携带更多的信息,类型也好,功能也好,同时作用域越大,变量名也应该涵盖的信息越多。
  • 写出让读者理解代码的注释(类级别写全局观的注释,具体细节写怎么做,有坑的地方写很难处理)
  • 使用换行与列对齐将“相似的代码看起来很相似”,优化代码的顺序使其更美观,复杂的流水线步骤代码添加空行分割步骤

1.1 变量名

变量名

标签:本书,变量名,概括,代码,注释,理解,编写,分享
From: https://www.cnblogs.com/wuxero/p/17758462.html

相关文章

  • 【时间的格局】 第一章 时间的陷阱---思维导图分享
    今天完成了【时间的格局】全书阅读。书本信息---  作者:黄静洁;出版社:中信出版集团;出版日期:2022年5月这是一本育儿类书籍,里面绝大部分的育儿观基本认同,也是我目前践行的育儿方法。书本阅完,整理、复盘、输出分享大家,供参考。下图为本书第一章节主要内容:  ......
  • 代码随想录算法训练营第一天(python) | 704. 二分查找、27. 移除元素。
    Leetcode704二分查找题目链接:704二分查找关键点思路:1、是否要进入到while部分的代码是left<=right还是left<right,看[left,right]是否是合法区间.例如[1,1]是合法区间,取<=;[1,1)非合法区间,取<。2、缩小区间时,考虑边界是否已经比较过。左闭右闭区......
  • 机器学习即代码的时代已经到来
    译者注:到底是AI会吃掉软件还是软件会吃掉AI?为了jobsecurity工程师应该把宝押在哪儿?这篇2021年的文章提供的一些视角似乎印证了它现在的流行,有点“运筹于帷幄之中,决胜于数年之后”的意思,颇值得软件架构师和产品经理们内省一番。2021版的《人工智能现状报告》于上周......
  • 彩虹猫bat代码
    #include<Windows.h>#include<TlHelp32.h>#include<Shlwapi.h>#include<Psapi.h>//必不可少的头文件intnext;constunsignedcharmsg[]="YOURCOMPUTERHASBEENEDBYTHEMEMZTROJAN.\r\n\r\nYourcomputerwon'tbootupag......
  • 【误码率仿真】基于QPSK信道经过高斯信道和瑞利信道条件下误码率仿真附Matlab代码
    ✅作者简介:热爱科研的Matlab仿真开发者,修心和技术同步精进,matlab项目合作可私信。......
  • 【RF分类】基于粒子群优化随机森林PSO-RF实现数据分类算法研究附matlab代码可直接运行
    ✅作者简介:热爱科研的Matlab仿真开发者,修心和技术同步精进,matlab项目合作可私信。......
  • 【leach协议】基于粒子群算法改进能量均衡高效WSN的LEACH协议附matlab代码
    ✅作者简介:热爱科研的Matlab仿真开发者,修心和技术同步精进,matlab项目合作可私信。......
  • 利用ChatGPT完成数字社区产品使用手册的编写
    利用ChatGPT完成数字社区产品使用手册的编写搜索的问题及答案:一、身为产品介绍师怎么介绍用户的登录的功能概述用户登录是我们手机软件中的一个重要功能,它为用户提供了一系列的便利和个性化的体验。通过登录,用户可以享受一下几个主要功能:1.个人化定制:登录后,用户可以根据自己......
  • 《代码大全》阅读笔记01
    1、开发前期准备相关需求阶段在需求阶段,我们需要明确定义用户的需求,这样不仅能够避免与用户的争议,还能够更好地让用户更快地熟悉系统、使用系统;处于该阶段的错误的解决时间最好接近于发现错误的时间,不然越拖越久,改正错误的代价就会相应的增大;架构优秀的软件架构很大程度上与......
  • 使用GoogleTest框架进行cpp代码的基本单元测试
    title:aliases:tags:-cpp/单元测试-cmake-工程技术category:-方法stars:url:creation-time:2023-10-1119:02modification-time:这里主要介绍从0开始实现基本的单元测试功能。构建首先从googletest代码仓下载源码。网上很多指导包括官方的指......