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

驾驭工程全景：从 Prompt Engineering 到 Context Engineering 再到 Harness Engineering 的三级跃迁

2020 年我们学会了跟模型说话（Prompt Engineering），2025 年我们学会了给模型喂信息（Context Engineering），2026 年我们学会了给模型搭脚手架（Harness Engineering）。这三个 Engineering 不是并列关系，而是严格的超集关系：PE ⊂ CE ⊂ HE。本文从"为什么上一个不够"的视角，系统梳理这条演进路径上的每一次范式跃迁。一个类比秒懂三级跃迁在讲技术之前，先用一个所有人都能理解的类比。想象你要指挥一个完全失忆的天才厨师做一桌满汉全席： Prompt Engineering 就是学会怎么跟厨师下达指令。你发现说"做道好吃的"不行，得说"用中火煎三分钟，翻面后加酱油 15 毫升"。这是措辞的艺术。 Context Engineering 就是学会怎么给厨师备料。光会下指令不够——厨师面前得摆好食材、调料、菜谱、食客的过敏信息。你要设计一个动态备料系统，让厨师在需要的时候拿到需要的东西。 Harness Engineering 就是学会怎么...

CI/CD 方法论

CI/CD 的重要性 Martin Fowler说过，“持续集成并不能消除Bug，而是让它们非常容易发现和改正。” 持续集成和持续交付作为敏捷开发的一种最佳实践，通过包括构建、部署、测试、发布流程的自动化，实现质量内建，让质量问题可以快速发现和消除，从而提升软件交付的质量和效率。基本策略分支模型是CICD落地的源头，研发过程各角色间的协作方式以及研发过程内代码版本的流转方式都取决于分支模型。首先划分环境。划分环境后设计分支，注重开发和发布两个场景。根据分支设计流水线，验证应该发生在全流水线里。一般的分支模型参考文献：《在阿里，我们如何管理代码分支？》《What is Trunk-Based Development?》《提升团队的微服务落地能力》

系分方法论交流笔记

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

业务分析方法

背景从 prd 出发，分析业务需求，寻找可以创造价值的方案。业务分析的价值全面分析用户的各项需求告诉我们“做什么” 业务分析的目的理解产品需求，识别业务范围分析业务模块的重要程度、优先级发现产品设计的不足为后后续测试分析做准备业务分析方法-整体过程用不同的动作达到不同的产出。理解需求背景（必须）举例：阿里巴巴账户体系要初步阐述：1. 产生什么价值。 2. 需要解决什么问题。3. 甚至要阐明要达到什么目标（比如，基于支付宝账户体系统一账户id）。现状分析（必须）产品定位现有业务架构产品业务范围规划业务架构**（1. 要有分期的意识，识别产品形态。 2. 要有清洗数据的方案，预测安全风险）** 识别（抽象分析建模）业务角色（实际上就是系统交互的输入方，有多少个角色，就需要关注多少个东西）自然人其他系统业务串联（为了找业务用例。业务串联就是把一堆文字描述串在一起）业务用例（建模-业务用例图用例是对场景的概括）分析业务用例（建模-活动图活动图是对用例的拆解）提炼（进一步建模）关键流程由活动图的 ...

第 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 章何处有更多的信息

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

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