美文网首页
简洁代码-注释

简洁代码-注释

作者: 茕茕踽踽 | 来源:发表于2017-06-30 17:01 被阅读0次

代码整洁之道笔记

[TOC]

注释

  1. 写出好的代码就不要注释啦。
  2. 逻辑实在复杂不得不加,那记得把注释将清楚。
  3. 别把注释写错了啊,不然看的人可能就雪崩。
  4. 写注释别啰里啰嗦,简明扼要。

一般需要加的注释有开头的版权信息:

/*
 * This file is part of Pimple.
 *
 * Copyright (c) 2009 Fabien Potencier
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

提供信息的注释:

/**
     * Gets a parameter or an object.
     *
     * @param string $id The unique identifier for the parameter or object
     *
     * @return mixed The value of the parameter or an object
     *
     * @throws \InvalidArgumentException if the identifier is not defined
     */
    public function offsetGet($id) {

    }

阐释和todo: //to do

相关文章

  • 简洁代码-注释

    代码整洁之道笔记 [TOC] 注释 写出好的代码就不要注释啦。 逻辑实在复杂不得不加,那记得把注释将清楚。 别把注...

  • c语言-符号

    注释 准确简洁,简单代码不要注释。不要用缩写写注释,写代码的原因而不是写运行过程。 符号\ 接续符,告诉编译器内容...

  • 手写Promise的实现

    1. 简洁版 (没有注释) 2. 详细注释版 3. 测试 4. 简单的伪代码 Promise实现伪代码 定义三种状...

  • 代码简洁之道-->注释与格式

    注释 按照代码简洁之道里面的说发,好的代码应该是没有注释的。只有表达不清楚含义,才需要用注释去辅助。这只是理想情况...

  • iOS常用代码块&注释规范

    简洁快捷的代码块能极大地提高开发效率 属性注释 快捷键:xx 多行注释 快捷键:zz #pragma mark —...

  • Android开发规范

    Android开发规范 持续健全规范 代码中不要出现中文,或者中文拼音 注释要求简洁清晰 变量命名:只包含字母,采...

  • Python 代码注释格式

    Python代码 注释 # 注释内容 # 订单模块 HTML代码 注释

  • Swift API 设计准则

    1.简洁经常有助于代码清晰,但是简洁本身不应该独自成为我们编码的目标。2.务必为函数添加文档注释 — 特别是泛型函...

  • Android studio 上非常好用的快捷键

    注释代码(//) Ctrl + / 注释代码(/**/) Ctrl + Shift + / 格式化代码 ...

  • Android Studio Mac快捷键

    // Command + / 注释代码 注释代码(/**/) Command + Option + / 格式...

网友评论

      本文标题:简洁代码-注释

      本文链接:https://www.haomeiwen.com/subject/ldricxtx.html