Loading...

What is the best comment in source code you have ever encountered? [closed]

Created2021-12-13|Updated2026-01-24

|Word Count:13|Reading Time:1mins|Post Views:

What is the best comment in source code you have ever encountered? [closed]

Author: magicliang

Link: https://magicliang.github.io/2021/12/13/What-is-the-best-comment-in-source-code-you-have-ever-encountered-closed/

Copyright Notice: All articles on this blog are licensed under CC BY-NC-SA 4.0 unless otherwise stated.

软件工程幽默

Related Articles

系分方法论交流笔记

分析、设计和架构的区别系分 = 业务分析 + 系统设计系分其实就是 Analysis + Design 业务分析才是最重要的大头要理解：架构约束项目约束要有：权衡选择的过程理解业务，要理解业务背后的东西，产出的是模型。一步一步走，推演出来解决方案，要有方法论。系统设计是很明确的工作了应用设计 + 数据设计 + 技术设计 = 系统方案要考虑的额外问题：非功能设计：运行关注点、运维关注点、开发关注点、测试关注点。项目约束常见方法论用例驱动设计 SOAD 面向服务的分析和设计 OOAD 面向对象分析和设计 DDD 领域驱动设计 DDD特别适合复杂系统。有一个以不变应万变的对象，才可以在未来承载复杂的业务演进过程。这几种方法论可以混合使用。需求分析与业务建模把 prd 从薄读到厚，把文档中缺失的部分补全。系分做 PRD 评审的时候，影响比较大的点一定要尽早确认。一些对系统变化可控，可预测的变化，可以暂时放过，后续在补充。面向服务的业务建模分析主业务服务，设计业务功能域，设计业务功能域边界。这个过程可能不断地螺旋式地重构。如果用...

软件设计，必有单元/片段，不管他们叫做系统、层次、模块、类型和方法，都是为了在一个抽象颗粒度上分割复杂度，让我们降低思考的难度，并且进行团队协作。我们在进行系统交互的时候，要尽量设计单元交叉点通过薄的中间层交互。也就是放弃直接性，拥抱间接性。间接性的实现，就是契约、接口或者门面/桥接模式。这些实践的使用，可以轻易让我们切换层次之间的实现，而使变动不扩散出去。

第 1 章欢迎进入软件构建的世界第 2 章用隐喻来更充分地理解软件开发第 3 章三思而后行：前期准备第 4 章关键的“构建决策” 第 5 章软件构建中的设计第 6 章可以工作的类第 7 章高质量的子程序第 8 章防御式编程第 9 章伪代码编程过程第 10 章使用变量的一般事项第 11 章变量名的力量第 12 章基本数据类型第 13 章不常见的数据类型第 14 章组织直线型代码第 15 章使用条件语句第 16 章控制循环第 17 章不常见的控制结构第 18 章表驱动法第 19 章一般控制问题第 20 章软件质量概述第 21 章协同构建第 22 章开发者测试第 23 章调试第 24 章重构第 25 章代码调整策略第 26 章代码调整技术第 27 章程序规模对构建的影响第 28 章管理构建第 29 章集成第 30 章编程工具第 31 章布局与风格第 32 章自说明代码第 33 章个人性格第 34 章软件工艺的话题第 35 章何处有更多的信息

语义版本化问题

语义化版本 2.0.0 《语义化版本 2.0.0》，三段版本号语义：版本格式：主版本号.次版本号.修订号（MAJOR.MINOR.PATCH），版本号递增规则如下：主版本号（MAJOR）：当你做了不兼容的 API 修改，次版本号（MINOR）：当你做了向下兼容的功能性新增，修订号（PATCH）：当你做了向下兼容的问题修正。先行版本号及版本编译信息可以加到"主版本号.次版本号.修订号"的后面，作为延伸。例如 1.0.0-alpha、1.0.0-beta.1、1.0.0-0.3.7。版本号的初始阶段在主版本号为 0.x.y 的阶段，API 被认为是不稳定的，任何变更都可能发生。这个阶段的软件不应该被用于生产环境。1.0.0 的发布意味着公共 API 的正式定义，后续的版本号变更都基于这个公共 API 的变化来递增。先行版本号（Pre-release）先行版本号通过在修订号后面加上连字符和一系列以点分隔的标识符来表示。例如： 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-beta < 1.0.0-b...

写代码 checklist 注意位置注意顺序注意初始化注意返回值注意注释注意防御性编程注意数据库性能上线 checklist 代码变更 check 代码配置变更 check 配置系统变更注意上线顺序依赖中间件变更注意配置中间件配置中心配了吗交互所有细节都实现了吗？配监控和埋点数据库变更了吗？安全检查

在智能体优先的世界中利用 Codex

原文作者：Ryan Lopopolo，OpenAI 技术人员。本文记录了 OpenAI 内部一个工程团队历时五个月、以"零人工编码"方式构建并交付真实软件产品的完整经验。在过去五个月里，我们的团队一直在进行一项实验：构建并交付一款软件产品的内部 beta 版，其中没有一行代码是人工编写的。该产品有内部日常活跃用户和外部 Alpha 测试者。它经历了交付、部署、故障和修复的整个过程。与众不同的是，每一行代码 — 从应用逻辑、测试、CI 配置、文档、可观察性到内部工具 — 全都是由 Codex 编写的。据估计，我们只用了手工编写代码所需的大约 1/10 的时间就完成了这项工作。人类掌舵。智能体执行。我们有意选择这一限制，以便构建必要的内容，从而将工程速度提升数个数量级。我们用了几周的时间来交付最终达到一百万行代码的项目。为此，我们需要了解，当软件工程团队的主要工作不再是编写代码，而是设计环境、明确意图和构建反馈回路，从而使 Codex 智能体能够可靠地工作时，会发生哪些变化。这篇文章要说的是，在我们与智能体团队一起从零开始打造一款全新产品的过程中，所...