《程序员修炼之道》读书笔记(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

相关文章

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么?基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建

Three.js构建一个 3D 商品展示空间完整实战项目

《Three.js构建一个3D商品展示空间完整实战项目》Three.js是一个强大的JavaScript库,专用于在Web浏览器中创建3D图形,:本文主要介绍Three.js构建一个3D商品展... 目录引言项目核心技术1. 项目架构与资源组织2. 多模型切换、交互热点绑定3. 移动端适配与帧率优化4. 可

sky-take-out项目中Redis的使用示例详解

《sky-take-out项目中Redis的使用示例详解》SpringCache是Spring的缓存抽象层,通过注解简化缓存管理,支持Redis等提供者,适用于方法结果缓存、更新和删除操作,但无法实现... 目录Spring Cache主要特性核心注解1.@Cacheable2.@CachePut3.@Ca

SpringBoot通过main方法启动web项目实践

《SpringBoot通过main方法启动web项目实践》SpringBoot通过SpringApplication.run()启动Web项目,自动推断应用类型,加载初始化器与监听器,配置Spring... 目录1. 启动入口:SpringApplication.run()2. SpringApplicat

Springboot项目构建时各种依赖详细介绍与依赖关系说明详解

《Springboot项目构建时各种依赖详细介绍与依赖关系说明详解》SpringBoot通过spring-boot-dependencies统一依赖版本管理,spring-boot-starter-w... 目录一、spring-boot-dependencies1.简介2. 内容概览3.核心内容结构4.

在ASP.NET项目中如何使用C#生成二维码

《在ASP.NET项目中如何使用C#生成二维码》二维码(QRCode)已广泛应用于网址分享,支付链接等场景,本文将以ASP.NET为示例,演示如何实现输入文本/URL,生成二维码,在线显示与下载的完整... 目录创建前端页面(Index.cshtml)后端二维码生成逻辑(Index.cshtml.cs)总结

Spring Boot项目如何使用外部application.yml配置文件启动JAR包

《SpringBoot项目如何使用外部application.yml配置文件启动JAR包》文章介绍了SpringBoot项目通过指定外部application.yml配置文件启动JAR包的方法,包括... 目录Spring Boot项目中使用外部application.yml配置文件启动JAR包一、基本原理

Springboot项目登录校验功能实现

《Springboot项目登录校验功能实现》本文介绍了Web登录校验的重要性,对比了Cookie、Session和JWT三种会话技术,分析其优缺点,并讲解了过滤器与拦截器的统一拦截方案,推荐使用JWT... 目录引言一、登录校验的基本概念二、HTTP协议的无状态性三、会话跟android踪技术1. Cook

springboot项目中集成shiro+jwt完整实例代码

《springboot项目中集成shiro+jwt完整实例代码》本文详细介绍如何在项目中集成Shiro和JWT,实现用户登录校验、token携带及接口权限管理,涉及自定义Realm、ModularRe... 目录简介目的需要的jar集成过程1.配置shiro2.创建自定义Realm2.1 LoginReal

idea Maven Springboot多模块项目打包时90%的问题及解决方案

《ideaMavenSpringboot多模块项目打包时90%的问题及解决方案》:本文主要介绍ideaMavenSpringboot多模块项目打包时90%的问题及解决方案,具有很好的参考价值,... 目录1. 前言2. 问题3. 解决办法4. jar 包冲突总结1. 前言之所以写这篇文章是因为在使用Mav