《程序员修炼之道》读书笔记(8):注重实效的项目

2024-09-06 23:18

本文主要是介绍《程序员修炼之道》读书笔记(8):注重实效的项目,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

第8章:注重实效的项目

随着项目开动,我们需要从个体的哲学与编码问题,转向为项目级别的问题。

本章将讨论影响项目成败的几个关键区域。

41《注重实效的团队》

本书在先前讨论了帮助程序员个体更好的方法,这些方法对团队也有效。
下面将针对团队,来重述前面部分章节。

  • 不要留破窗户。团队不应该容忍那些小小的、无人修正的不完美。
  • 煮青蛙。团队更容易被煮熟,因为每个人都觉得别人会在监视环境的变化。
  • 交流。不仅团队内部需要交流,团队也需要和外部交流。
  • DRY。消除团队成员之间的重复。
  • 正交性。我们喜欢围绕功能、而不是工作职务进行组织。
  • 自动化。尽量自动化,这很重要。
  • 知道何时停止绘画。抵抗不继续画下去的诱惑。

42《无处不在的自动化》

让一切尽可能地自动化。尽量避免手动流程。

例如:

  • 项目编译
  • 生成代码
  • 回归测试
  • 构建

还可以让一些管理方面地事物自动化,例如:

  • 网站生成(在线文档、报告等)
  • 批准流程

我们有很多工具可以帮助我们自动化,比如 命令行make各种脚本 等等。或者也可以自己开发工具。

让计算机去做重复、庸常的事情——它们会做得比我们更好。我们有更重要、更困难的事情要做。

43《无情的测试》

  • 早测试
  • 常测试
  • 自动测试

测试什么?

  • 单元测试。对某个模块演练得代码
  • 集成测试。子系统之间能否协同。
  • 验证和校验。看是否能满足需求。
  • 资源耗尽、错误及恢复。资源包括:内存空间、磁盘空间、CPU带宽、挂钟时间、磁盘带宽、网络带宽、调色板、视频分辨率等。
  • 性能测试
  • 可用性测试。真正让用户测试。

怎样测试?

  • 回归测试。把当前得输出和之前得输出对比。
  • 测试数据。你可能会用到现实数据合成数据
  • 演练GUI系统
  • 对测试进行测试。确保测试确实起效。
  • 彻底测试。事实上你不可能确定所有BUG都被找到了,但是有些工具可以帮助你,比如覆盖分析

何时进行测试?

  • 尽快
  • 如果有限制,则确保它出现在计划中。

如果有BUG漏过测试网——增加新的测试,以便下一次抓住它。

44《全都是写》(文档)

你应把文档视为开发过程中的完整组成部分。如果可能的话,可以将文档放在代码中。

为项目制作的文档分为两部分:

  • 内部文档:源码注释、设计、测试等等。
  • 外部文档:用户手册等。

关于代码中的注释:

代码应该有注释,但是太多注释和太少注释一样糟糕

一般而言,注释讨论为何要做某件事、他的目的
至于如何去做,代码已经说明了。因此就不需要注释了,而且违反了 DRY

注释给了你机会,可以把那些难以描述、容易忘记、却又不能记载在别的地方的东西记录下来,例如:

  • 工程上的权衡
  • 为何要做出某些决策
  • 放弃了哪些方案
  • 任何不明了的事儿

JavaDoc所提倡的注释程度似乎是合适的:

/*** Find the peak (highest) value within a specified date* range of samples.* @parm aRange Range of dates to search for date.* @parm aThreshold Minimum value to consider.* @return the value, or null if no value found greater than or equal to the threshold.*/public Sample findPeak(DateRange aRange, double aThreshold);

不应该出现在文档中的:

  • 文件中的代码导出的函数——自动工具可以生成。
  • 修改历史——版本控制系统中有。
  • 该文件使用的其他文件的列表——自动工具可以生成
  • 文件名——应该自动更新
  • 任何其他可以自动生成的东西

如果注释符合格式,JavaDoc这样的工具就可以自动产出 API级的文档。


可执行文档:使用文档中的信息同步到实际数据。这样就遵守了 DRY

文档不应该由专人撰写。

文档最好发布到Web上而不是打印。

使用DocBook等现代的标记语言。

45《极大的期望》(与用户交流期望)

一个小孩打开了昂贵的圣诞礼物,但是却哭了
——尽管你的礼物很贵,但她只想要一个廉价的洋娃娃。

抽象意义上,假如正确实行规范,那么就是成功的。
但在现实中,项目的成功是由它在多大程度上满足了用户的期望来衡量的。

你应该在开发过程中持续和用户交流,达成对未来期望的共同理解。

46《傲慢与偏见》(为自己的工作签名)

让每个人为自己的工作签名。

这样既能防止逃避责任。

也让每个人有了自豪感。

这篇关于《程序员修炼之道》读书笔记(8):注重实效的项目的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1143392

相关文章

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一:修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录,测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的

springboot集成Deepseek4j的项目实践

《springboot集成Deepseek4j的项目实践》本文主要介绍了springboot集成Deepseek4j的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录Deepseek4j快速开始Maven 依js赖基础配置基础使用示例1. 流式返回示例2. 进阶

SpringBoot项目启动报错"找不到或无法加载主类"的解决方法

《SpringBoot项目启动报错找不到或无法加载主类的解决方法》在使用IntelliJIDEA开发基于SpringBoot框架的Java程序时,可能会出现找不到或无法加载主类com.example.... 目录一、问题描述二、排查过程三、解决方案一、问题描述在使用 IntelliJ IDEA 开发基于

SpringBoot项目使用MDC给日志增加唯一标识的实现步骤

《SpringBoot项目使用MDC给日志增加唯一标识的实现步骤》本文介绍了如何在SpringBoot项目中使用MDC(MappedDiagnosticContext)为日志增加唯一标识,以便于日... 目录【Java】SpringBoot项目使用MDC给日志增加唯一标识,方便日志追踪1.日志效果2.实现步

Ubuntu中Nginx虚拟主机设置的项目实践

《Ubuntu中Nginx虚拟主机设置的项目实践》通过配置虚拟主机,可以在同一台服务器上运行多个独立的网站,本文主要介绍了Ubuntu中Nginx虚拟主机设置的项目实践,具有一定的参考价值,感兴趣的可... 目录简介安装 Nginx创建虚拟主机1. 创建网站目录2. 创建默认索引文件3. 配置 Nginx4

SpringBoot项目启动错误:找不到或无法加载主类的几种解决方法

《SpringBoot项目启动错误:找不到或无法加载主类的几种解决方法》本文主要介绍了SpringBoot项目启动错误:找不到或无法加载主类的几种解决方法,具有一定的参考价值,感兴趣的可以了解一下... 目录方法1:更改IDE配置方法2:在Eclipse中清理项目方法3:使用Maven命令行在开发Sprin

Nginx实现高并发的项目实践

《Nginx实现高并发的项目实践》本文主要介绍了Nginx实现高并发的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录使用最新稳定版本的Nginx合理配置工作进程(workers)配置工作进程连接数(worker_co

Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)

《Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)》文章介绍了如何使用dhtmlx-gantt组件来实现公司的甘特图需求,并提供了一个简单的Vue组件示例,文章还分享了一... 目录一、首先 npm 安装插件二、创建一个vue组件三、业务页面内 引用自定义组件:四、dhtmlx

SpringBoot项目注入 traceId 追踪整个请求的日志链路(过程详解)

《SpringBoot项目注入traceId追踪整个请求的日志链路(过程详解)》本文介绍了如何在单体SpringBoot项目中通过手动实现过滤器或拦截器来注入traceId,以追踪整个请求的日志链... SpringBoot项目注入 traceId 来追踪整个请求的日志链路,有了 traceId, 我们在排