开发者社区 > PolarDB开源 > PolarDB PostgreSQL 版 > 正文

C语言错误消息撰写规范?

已解决

C语言错误消息撰写规范?

展开
收起
云上静思 2022-10-18 16:10:05 622 0
1 条回答
写回答
取消 提交回答
  • 推荐回答

    一、 消息的构成:

    1. Primary: could not create shared memory segment: %m

    2. Detail: Failed syscall was shmget(key=%d, size=%u, 0%o).

    3. Hint: the addendum

    二、 引号:

    1. 在引用时,英语文本应该使用双引号

    2. 总是用引号界定文件名、用户提供的标识符以及其他可能包含词的变量。不要用它们来标记不会包含词的变量.

    三、 语法和标点:

    1. 主要错误消息:第一个字母不要大写。不要用一个句点结束一个消息。甚至不要考虑用一个感叹号结束一个消息

    2. 详细和提示消息:使用完整的句子,并且每一个都用句点结束。对句子的第一个词进行首字母大写。如果后面跟着另一个句子,在句号后面放两个空格。

    四、 大写和小写:

    1. 对消息使用小写形式,包括一个主要错误消息的第一个字母。如果 SQL 命令或者关键词出现在消息中,请 为它们使用大写

    五、 避免被动态:

    1. 使用主动语态。在有主语时使用完整句子(“A could not do B”)。如果主语是程序本身,使用没有主 语的电报风格,但不要为程序使用“I”.

    六、 现在时和过去时:

    1. 如果一次尝试做某事失败但是可能在下一次成功(也许在修复某个问题之后),则使用过去时。如果失败必 定是持久的,请使用现在时, 如下有何区别: could not open file “%s”: %m 和 cannot open file “%s”

    七、 对象类型:

    1. 在引用一个对象的名称时,说明该对象的类型。否则没有人会了解“foo.bar.baz”具体是什么

    八、 组装错误信息:

    1. 当一个消息包括在别处产生的文本时,这样将它嵌入 could not open file %s: %m.

    2. 消息应该总是说明为什么错误会发生的原因。如果没有已知原因,你最好修复代码, 例如 BAD: could not open file %s BETTER: could not open file %s (I/O failure) 3. 不要在消息中写函数名.

    3. 避免缩略语。例如“can't”,请使用“cannot”

    4. 避免使用 Unable Bad Illegal Unknown BAD: unknown node type BETTER: unrecognized node type: 42

    5. Find还是Exists

    以上内容摘自《PolarDB for PostgreSQL 源码与应用实战》电子书,点击https://developer.aliyun.com/ebook/download/7773可下载完整版

    2022-10-18 17:23:14
    赞同 展开评论 打赏

云原生数据库 PolarDB PostgreSQL 版是阿里云完全自主研发的云原生关系型数据库产品,100%兼容 PostgreSQL。

相关产品

  • 云原生数据库 PolarDB
  • 相关电子书

    更多
    当泛型遇上协议 立即下载
    用RxSwift写易维护易读的愉悦代码 立即下载
    低代码开发师(初级)实战教程 立即下载