代码注释规范[转载]

代码注释规范-转载

本文以 JavaScript 编程语言为例阐述。

注释类型一

下面的内容参考源代码

  • 文件头注释

    在代码文件最上面的写上块注释。参考下面的代码:

/*!
 * parseurl
 * Copyright(c) 2014 Jonathan Ong
 * Copyright(c) 2014-2017 Douglas Christopher Wilson
 * MIT Licensed
 */
  • 函数头注释

    在函数前面写上函数的作用和入口参数和返回值类型,甚至是业务逻辑和算法。参考下面的代码:

/**
 * Determine if parsed is still fresh for url.
 *
 * @param {string} url
 * @param {object} parsedUrl
 * @return {boolean}
 * @private
 */

function fresh(url, parsedUrl) {
  return (
    typeof parsedUrl === "object" &&
    parsedUrl !== null &&
    (Url === undefined || parsedUrl instanceof Url) &&
    parsedUrl._raw === url
  );
}
  • 伪代码注释

    在函数内部写上业务逻辑的步骤或者关键语句的注释。参考下面的代码:

function originalurl(req) {
  var url = req.originalUrl;

  if (typeof url !== "string") return parseurl(req); // Fallback

  var parsed = req._parsedOriginalUrl;

  if (fresh(url, parsed)) return parsed; // Return cached URL parse

  // Parse the URL
  parsed = fastparse(url);
  parsed._raw = url;

  return (req._parsedOriginalUrl = parsed);
}

注释分类二

  • 块注释

    /**/ 包围的多行代码注释,例如,文件头注释和函数头注释。见上面的代码。

  • 行注释

    // 开头的注释,主要用与函数内部的伪代码注释。

  • 半行注释

    // 开头的注释,写在被注释代码的右面。

    注意:

注释规范

  • 代码行数少于五行的函数可以不写函数头注释
  • 不必要对每行代码都写注释
  • 不必要对每个函数都写注释
  • 关键的业务逻辑和算法应该写伪代码注释
  • 关键的业务逻辑和算法应该写函数头注释
  • 函数头注释中必须写以下内容:
    • 函数的功能
    • 函数的入口参数类型
    • 函数的返回值类型
    • 函数的算法或者业务逻辑
  • JavaScript 代码的注释采用 JSDoc 规范,更多内容请参考
  • Java 代码的注释采用 JavaDoc 规范,PHP 代码的注释采用 PHPDoc 规范
  • 两个注释工具的使用:
    • IDE 中使用 JSDoc 插件,利用插件快速完成注释代码的编写
    • vim 中使用 vim-jsdoc
    • 使用命令行 JSDoc 工具,可以从代码中提取注释形成文档资料,更多内容请参考

推荐阅读更多精彩内容

  • 前言:如果你有更好的私藏文章,不凡分享出来,独乐乐不如众乐乐(⊙o⊙) 一、为什么要规范注释: 代码注释是架起程序...
    utopia84阅读 234评论 0 3
  • 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节...
    HejinYo阅读 395评论 0 0
  • 写注释如果方法不对,是比没写还恶劣的行为! 我想到的,常见的情况有: 1. 注释不规范或过度注释 随意的,到处都是...
    Jalonly阅读 413评论 0 0
  • 目的和原则 提高可读性和可维护性如无必要,勿增注释;如有必要,尽量详尽 语法和快捷键 单行注释://快捷键: ct...
    lesdom阅读 4,892评论 0 0
  • 注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。 php里面常...
    xiaophp_cn阅读 241评论 0 2