Doc API standard

背景

为保证文档中 API 描述信息的一致规范，拟按照现有书写规范，及 #25056、#20907 中对 string 和 boolean 的讨论结果，将 API 中各类型和书写方式进行统一。并写入 Wiki 中。

• Wiki

链接

https://ant.design/components/button-cn/#API

目标

https://github.com/ant-design/ant-design/wiki/API-Naming-rules

举例

参数	说明	类型	默认值
htmlType	xxx	string	button
type	xxx	horizontal | vertical	horizontal
disabled	xxx	boolean	false
minLength	xxx	number	0
style	xxx	CSSProperties	-
character	xxx	(props) => ReactNode	-
offset	xxx	[number, number]	[0, 0]
value	xxx	string | number	small

约定

• string 类型时，默认值使用 ``。
• 也可在类型中列举 string 可选值。
• boolean 类型时，默认值使用 true 或 false。
• number 类型时，默认值直接使用数字。
• function 类型时，在类型中使用箭头函数表达式。
• 无默认值使用 - 。
• 说明末尾无句号。
• API 顺序按照字母顺序进行排列，特殊情况可放在一起（如：xs sm md）。

---

Examples

Property	Description	Type	Default
htmlType	xxx	string	button
type	xxx	horizontal | vertical	horizontal
disabled	xxx	boolean	false
minLength	xxx	number	0
style	xxx	CSSProperties	-
character	xxx	(props) => ReactNode	-
offset	xxx	[number, number]	[0, 0]
value	xxx	string | number	small

Promise

• When string type, the Default use ``.
• Can also list string optional values ​​in Type.
• When boolean type, the Default value is true or false.
• When number type, the Default value use numbers directly.
• When function type, use an arrow function expression in Type.
• No default value use - .
• Capitalize the first letter in Description apart from someProp.
• No period at the end of the Description.
• API order is arranged in alphabetical order, and can be put together under special circumstances (such as: xs sm md).

[xrkffgg]

Done.

[xrkffgg]

已更新 Wiki，计划 4.4.0 上线后，再逐步统一。