Lruihao's Note

不怕萬人阻擋,只怕自己投降

浏览器渲染原理

浏览器是如何渲染页面的? 当浏览器的网络线程收到 HTML 文档后,会产生一个渲染任务,并将其传递给渲染主线程的消息队列。 在事件循环机制的作用下,渲染主线程取出消息队列中的渲染任务,开启渲染流程。 整个渲染流程分为多个阶段,分别是: HTML 解析、样式计算、布局、分层、绘制、分块、光栅化、画 每个阶段都有明确的输入输出,上

中文技术文档的写作规范

以下参考来源:阮一峰的 中文技术文档的写作规范

英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软MailChimpAppleYahoodockerStruts 等等(维基百科有一份完整的清单)。中文的也有不少,但都不令人满意,要么太简单,要么不太适用。

对于开发者来说,在工作中也需要适当地产出一些技术文档,但是很多人都不知道怎么写文档,都是凭着感觉写。

对于开发的系统、软件而言,系统用词的准确性和统一性也显得十分重要。

参考上面的规范,于是有了下面一份中文技术文档的写作规范。

语义版本控制(SemVer)

摘要

版本格式:MAJOR.MINOR.PATCH,版本号递增规则如下:

  1. MAJOR: 主版本号,当你做了不兼容的 API 修改
  2. MINOR: 次版本号,当你做了向下兼容的功能性新增
  3. PATCH: 修订号,当你做了向下兼容的问题修正

先行版本号及版本编译信息可以加到 MAJOR.MINOR.PATCH 的后面,作为延伸。

Commit Message Spec

Commit messages are short descriptions of changes to a repository. We should follow certain standards to effectively describe changes, such as the Conventional Commits specification based on the Angular convention that is most used on GitHub, or each development team can simplify and formulate their own commit specification. This is not only conducive to the automatic generation of Changelog in the later stage, but more importantly, when a bug occurs, the entire warehouse can be quickly checked, the problem point can be accurately located, and the version can be reverted.

0%