开发者社区 > PolarDB开源 > PolarDB 分布式版 > 正文

编码中,错误消息如何撰写?

已解决

编码中,错误消息如何撰写?

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

    错误消息通常分成三部分,主要的错误消息是简单概要的介绍一下这是什么错误,如果这个简单概要的信息不够完整,或 者不能够足够表达出具体的错误,也可以通过添加Detail信息,把具体的细节打印出来。

    同时,如果你提供了比如对错误的一些修复建议,可以通过这种Hint的方式进行加入,比如可以提供一下这个东西是不是 文件不见了,可以去做一些文件添加等提示信息。

    然后就是引号,因为在引用时,英文文本都应该使用双引号,我们通常用这个引号界定文件名,包括用户提供的一些标识 服务,以及其他可能包含词的变量,不要用他们标记那些不包含词的变量。为什么要这么做?实际上因为我们有一些对象 插入到信息中是会产生歧义的,如果不用双引号,那就产生了歧义,把它插到消息中,通过双引号可以避免歧义。

    还有就是语法和标点类主要错误信息,例如通常第一个字母不要大写,不要用一个句点结束一个消息,甚至不要考虑用一 个感叹号结束一个消息。

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

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

    2022-10-18 17:12:19
    赞同 展开评论 打赏

PolarDB 分布式版 (PolarDB for Xscale,简称“PolarDB-X”) 是阿里云自主设计研发的高性能云原生分布式数据库产品,为用户提供高吞吐、大存储、低延时、易扩展和超高可用的云时代数据库服务。

相关电子书

更多
低代码开发师(初级)实战教程 立即下载
冬季实战营第三期:MySQL数据库进阶实战 立即下载
阿里巴巴DevOps 最佳实践手册 立即下载