代码注释规范[转载]

代码注释规范-转载

本文以 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 工具,可以从代码中提取注释形成文档资料,更多内容请参考
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容

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