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

相关文章

部署Vue项目到服务器后404错误的原因及解决方案

《部署Vue项目到服务器后404错误的原因及解决方案》文章介绍了Vue项目部署步骤以及404错误的解决方案,部署步骤包括构建项目、上传文件、配置Web服务器、重启Nginx和访问域名,404错误通常是... 目录一、vue项目部署步骤二、404错误原因及解决方案错误场景原因分析解决方案一、Vue项目部署步骤

golang内存对齐的项目实践

《golang内存对齐的项目实践》本文主要介绍了golang内存对齐的项目实践,内存对齐不仅有助于提高内存访问效率,还确保了与硬件接口的兼容性,是Go语言编程中不可忽视的重要优化手段,下面就来介绍一下... 目录一、结构体中的字段顺序与内存对齐二、内存对齐的原理与规则三、调整结构体字段顺序优化内存对齐四、内

配置springboot项目动静分离打包分离lib方式

《配置springboot项目动静分离打包分离lib方式》本文介绍了如何将SpringBoot工程中的静态资源和配置文件分离出来,以减少jar包大小,方便修改配置文件,通过在jar包同级目录创建co... 目录前言1、分离配置文件原理2、pom文件配置3、使用package命令打包4、总结前言默认情况下,

python实现简易SSL的项目实践

《python实现简易SSL的项目实践》本文主要介绍了python实现简易SSL的项目实践,包括CA.py、server.py和client.py三个模块,文中通过示例代码介绍的非常详细,对大家的学习... 目录运行环境运行前准备程序实现与流程说明运行截图代码CA.pyclient.pyserver.py参

IDEA运行spring项目时,控制台未出现的解决方案

《IDEA运行spring项目时,控制台未出现的解决方案》文章总结了在使用IDEA运行代码时,控制台未出现的问题和解决方案,问题可能是由于点击图标或重启IDEA后控制台仍未显示,解决方案提供了解决方法... 目录问题分析解决方案总结问题js使用IDEA,点击运行按钮,运行结束,但控制台未出现http://

解决IDEA使用springBoot创建项目,lombok标注实体类后编译无报错,但是运行时报错问题

《解决IDEA使用springBoot创建项目,lombok标注实体类后编译无报错,但是运行时报错问题》文章详细描述了在使用lombok的@Data注解标注实体类时遇到编译无误但运行时报错的问题,分析... 目录问题分析问题解决方案步骤一步骤二步骤三总结问题使用lombok注解@Data标注实体类,编译时

C语言小项目实战之通讯录功能

《C语言小项目实战之通讯录功能》:本文主要介绍如何设计和实现一个简单的通讯录管理系统,包括联系人信息的存储、增加、删除、查找、修改和排序等功能,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录功能介绍:添加联系人模块显示联系人模块删除联系人模块查找联系人模块修改联系人模块排序联系人模块源代码如下

SpringBoot项目中Maven剔除无用Jar引用的最佳实践

《SpringBoot项目中Maven剔除无用Jar引用的最佳实践》在SpringBoot项目开发中,Maven是最常用的构建工具之一,通过Maven,我们可以轻松地管理项目所需的依赖,而,... 目录1、引言2、Maven 依赖管理的基础概念2.1 什么是 Maven 依赖2.2 Maven 的依赖传递机

Vue项目中Element UI组件未注册的问题原因及解决方法

《Vue项目中ElementUI组件未注册的问题原因及解决方法》在Vue项目中使用ElementUI组件库时,开发者可能会遇到一些常见问题,例如组件未正确注册导致的警告或错误,本文将详细探讨这些问题... 目录引言一、问题背景1.1 错误信息分析1.2 问题原因二、解决方法2.1 全局引入 Element

Python 中 requests 与 aiohttp 在实际项目中的选择策略详解

《Python中requests与aiohttp在实际项目中的选择策略详解》本文主要介绍了Python爬虫开发中常用的两个库requests和aiohttp的使用方法及其区别,通过实际项目案... 目录一、requests 库二、aiohttp 库三、requests 和 aiohttp 的比较四、requ