areacodes icon indicating copy to clipboard operation
areacodes copied to clipboard

收集代码变更的文本描述

Open yescallop opened this issue 3 months ago • 0 comments

假定你已经读过 diff 规范,下列规则说明如何收集代码变更的文本描述(以下简称变更描述)。

  1. 变更描述收集在差异表中,每条变更描述由一行或多行连续的注释行组成,其所描述的是紧接其后的一行或多行连续的变更行。为了兼容差异表中旧的注释,只有当差异表第一行的内容为 #![described] 时,该表中其余的注释行才能被解析为变更描述。
  2. 对于一条变更描述,将组成其的注释行行首的 # 与其后的空白字符去除后,以 \n 连接各行即得到其内容。变更描述的内容使用 Markdown 语法,可使用标题分级,一级标题隐含在其描述的变更中,二级标题由单个 # 起始,以此类推(与 Rust 的文档注释类似)。
  3. 变更描述应尽可能详细,对于引用文本必须说明其来源,尽可能使用超链接。为防止链接失效,可采用自动化脚本将对应的网页或文件存档。例子参见 2022-2023.diff

Useful APIs: Wayback Machine APIs, Save Page Now 2 API.

yescallop avatar Mar 10 '24 08:03 yescallop