RFC2119
这个规范里规定几个常用语气词:MUST
, MUST NOT
, REQUIRED
, SHALL
, SHALL NOT
, SHOULD
, SHOULD NOT
, RECOMMENDED
, MAY
, OPTIONAL
的语气强度;
整理如下:
MUST
(或者REQUIRED
、SHALL
):绝对要;MUST NOT
(或者SHALL NOT
):绝对不要;SHOULD
(或者RECOMMENDED
):一般情况下要,建议要,可以有例外情况;SHOULD NOT
(或者NOT RECOMMENDED
):一般情况下不要,建议不要,可以有例外情况;MAY
(或者:OPTIONAL
):可以做,也可以不做;
在软件开发的过程中面对面的交流、接口文档的编写,其中的语气用词表达的意思可能有模糊地带,专门用这样一个规范来界定非常有必要;
【语义化版本】的文档就是这个规范不错的践行者;