Kevin's Blog

写技术文档时，选对结构比堆砌内容更重要。结构决定了读者的阅读路径：他是来”解决一个问题”，还是来”理解一件事”，抑或是来”做一个决定”。下面按读者意图归纳常见结构。 一、结构速查表 结构段落骨架适用场景问题解决型（最通用）背景 → 方案 → 实现 → 验证 → 总结具体技术问题的解法记录，如「如何把 List 传给可变参数方法」概念科普型是什么 → 为什么 → 怎么做术语与原理入门，如「什么是 CAS」「什么是 NPE」排错复盘型现象 → 定位过程 → 根因 → 修复 → 预防线上故障复盘、Bug 排查笔记、FAQ并列清单型结论先行 + 若干平级要点编码规范、最佳实践、速查表，如「设计模式的

背景 可变参数（variable arity parameter，简称 vararg）方法是指形如 void doSomething(String... args)、可以接收数量不确定的同类型实参的方法。 需要明确的是：可变参数在编译后就是数组。也就是说，String... args 与 String[] args 的方法签名完全等价，调用方实际传入的必须是一个 String[]。正因为这个约束，List 不能作为实参直接传给可变参数方法，必须先转换为数组。 方案 将一个 List 传给可变参数方法，标准做法是： 1. 通过 Collection.toArray(T[]) 把 List

软件设计模式原则提供了一些常用的思想和准则，让我们在开发软件系统时采用标准化的方法，使得我们能够开发出高质量、易读和易扩展的代码。软件设计模式原则主要包括以下几个方面： 单一职责原则 单一职责原则（SRP）的定义：一个类应该只有一个引起它变化的原因。一个类只负责一种职责，不会有太多的改变。这样当需求变化时，只需要修改对应的类，而不会让其它的类受到影响。这个原则可以避免类的耦合性太高，导致修改代码时需要修改其它很多的类的问题。 开放-封闭原则 开放-封闭原则（OCP）的定义：软件实体（类、模块、函数等等）应该可以轻易地扩展，但是却不应该容易地修改。这个原则的意思是，一个模块应该如何添加新的功