首页 > 其他分享 >阅读笔记三

阅读笔记三

时间:2023-10-31 23:15:53浏览次数:27  
标签:代码 笔记 注释 阅读 规则 格式 团队 糟糕

第四章:注释

注释的恰当用法是弥补我们在用代码表达意图是遭遇的失败。

注释不能美化糟糕的代码

写注释的常见动机之一是糟糕的代码的存在,带有少量注释的整洁而有表达力的代码,要比带有大量注释的零碎二复杂的代码像样得多。

与其花时间编写解释你写的糟糕的代码的注释,不如花时间清理那堆糟糕的代码。

第五章:格式

你应该保持良好的代码格式,你应该选用一套管理代码格式的简单规则,然后贯彻这些规则。

格式的目的:格式关乎沟通,而沟通是专业开发者的头等大事。

垂直格式:向报纸学习,名称应当简单且一目了然。

横向格式:水平方向上的区隔与靠近,用空格字符将彼此紧密相关的事物连接到一起,也用空格字符把相关性较弱的事物区隔开。水平对齐缩进.

团队规则:每个程序员都有自己喜欢的格式规则,但如果在团队中工作,就是团队说了算。

标签:代码,笔记,注释,阅读,规则,格式,团队,糟糕
From: https://www.cnblogs.com/lvxiaotong/p/17801896.html

相关文章

  • 【数值分析笔记】
    第3章-函数逼近3.1内积空间3.1.1内积设$f(x),g(x)\inC[a,b],\rho(x)$是\([a,b]\)上的权函数,积分\[(f,g)=\int_a^b\rho(x)f(x)g(x)dx\]称为函数\(f(x)\)与\(g(x)\)在\([a,b]\)上的内积。\(C[a,b]\)表示在区间\([a,b]\)内连续的全体函数组成的集合。满......
  • 第二章读书笔记
    03运行超市抹零结账行为#输入购物金额purchase_amount=float(input("请输入购物金额:"))#计算抹零后的金额rounded_amount=round(purchase_amount)#输出抹零后的金额print("抹零后的金额:",rounded_amount)‪‬‪‬‪‬‪‬‪‬‮‬‪‬‫‬‪‬‪‬‪‬‪‬......
  • 大数据分析与应用笔记
    定义大数据:是需要新处理模式才能具有更强的决策力、洞察发现力和流程优化能力的海量、高增长率和多样化的信息资产。数量(Volume)、种类(Variety)、速度(Velocity)、价值(Value)、准确性(Veracity)(1)数据清理:消除噪声和删除不一致数据。(2)数据集成:多......
  • 读书笔记chapter?2
    1#03超市抹零2bill=float(input("请输入商品的总价格"))3print("{:.0f}".format(bill))1#04成绩分差和平均值2importmath34grade1=int(input())5grade2=int(input())6grade3=int(input())7gap1=abs(grade1-grade2)8gap2=abs(grade2-grade3)......
  • [学习笔记]TypeScript查缺补漏(一):类
    @目录基础知识创建类型类的初始化类型和值JSDoc注释字段私有字段可选和非可选字段字段类型约束Getter/Setter静态成员函数重载构造函数参数属性类的实例化箭头函数this的作用域全局类和对象方法泛型泛型类泛型接口泛型函数装饰器基础知识创建类型classAbc{}类的初始化co......
  • 第二章读书笔记
    #03超市抹零结账行为print('学号:3121')print("\n03")n=eval(input('应付:'))print('实付:',int(n))#04计算学生成绩的分差和平均分print("\n04")print('学号:3121')A=eval(input('学生A的成绩:'))B=eval(input('学生B的成绩:')......
  • 【Django-DRF】多年积累md笔记 0基础到高手. 第(3)篇:使用Django开发REST 接口
    本文从分析现在流行的前后端分离Web应用模式说起,然后介绍如何设计RESTAPI,通过使用Django来实现一个RESTAPI为例,明确后端开发RESTAPI要做的最核心工作,然后介绍DjangoRESTframework能帮助我们简化开发RESTAPI的工作。完整版笔记直接地址:请移步这里共5章,24子模块,总计1.7......
  • 第二章读书笔记
    #03超市抹零结账3131money=eval(input("请输入商品总价:"))print("抹零后应收{}元".format(int(money)))#04计算学生成绩的分差和平均分3131student1_point=eval(input("请输入学生成绩:"))student2_point=eval(input("请输入学生成绩:"))print("分差为{},平均分为{}".f......
  • C语言笔记2
     程序的三种基本结构1.顺序结构:按照语句的顺序书写次序2.选择结构:通过特段特定条件,选择一个分支执行3.循环结构:在给定的条件下,反腐执行循环体,直到条件不满足为止 程序设计的步骤1.分析问题,建立数学模型2.确定数据结构3.确定算法,描述算法4.编制程序,调试程序5.运行结果......
  • 阅读笔记
    这个学期,我们开始了我们的软件需求分析的课程,这门课程教会了我软件需求分析的重要性以及必要性。在上课的时候,老师给我们推荐了几本书,对于我们现阶段的学习有着一定的帮助,于是我就看了其中的《实例化需求:团队如何交付正确的软件》这本书。这本书是在世界各地调查了多个团队软件交......