docs(comment-scope): 色碼列進允許項,不再當編號看
「允許寫進註解」那張表加一列:十六進位色碼。理由寫在同一列——它指的是顏 色,不是編號;只有純十進位的才當議題編號看。 守門腳本那一邊已經多剪一條,把井號後面含十六進位字母的色碼先剪掉。正文 是規則的唯一真實來源,腳本剪了一條而正文不動,下一個讀正文的人會以為色 碼仍然違規,於是把註解裡的色碼手動刪掉,或反過來覺得腳本放水。兩邊對不 起來,規則就沒有人信。 補的是一列,不是一段。既有六列的欄位次序照舊,允許項、理由、範例三格都 填滿,範例挑樣式表註解裡標主色那種常見寫法,讀的人一眼看得出這條規則在 講哪種場景。 影響註解範圍的判準本身,也就是所有讀這份正文的人與所有引用它的技能:註 解裡寫色碼從此明文放行,議題編號、需求編號那些照舊禁止。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -88,6 +88,7 @@
|
||||
| 第三方套件的 issue 連結 | 說明繞道寫法的成因與解除條件 | `// 繞過 github.com/foo/bar/issues/88,修好後可移除` |
|
||||
| 授權標頭、SPDX 標記 | 法律要求 | `// SPDX-License-Identifier: MIT` |
|
||||
| 語言原生標記 | 編譯器或工具鏈直接解讀 | `@deprecated`、`@since` |
|
||||
| 十六進位色碼 | 指的是顏色,不是編號;純十進位的才當議題編號看 | `/* 主色沿用 #7c3aed,別再調 */` |
|
||||
|
||||
`@author` 不在允許之列:它是人名,屬「流程與人事資訊」。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user