工作未始，规范先行！浅谈代码规范。

初次尝试写博客，标准为先。

本人认为：工程未始，规范先行！这不应该是硬性规定，而应该是默守心中的常识，统一而规范、通俗而易读。不管技术业务水平多牛或者多水，都应该遵循一套标准，方便他人，最重要的也是方便自己，给别人看，也是给自己看。计算机行业发展到今天，各种工程化、模块化的思维贯穿其中，本意也是以人为本，更好的让人通读与编码。

常见代码注释格式

1 < !-- -->注释，用于html代码

以html为例

< !--这是一段注释。注释不会在浏览器中显示。-->

<p>这是一段普通的段落。</p>

2 以/*开始，最好对齐。

以CSS为例

/*border:1px solid #fff*/
position:relative;

width:10rem;
/*padding:0;
margin-right:1rem;
background-color:pink;
opacity:1;*/

以JavaScript为例

/**
 * 文件名：[文件名]
 * 作者：〈版权〉
 * 描述：〈描述〉
 * 修改人：〈修改人〉
 * 修改时间：YYYY-MM-DD
 * 修改内容：〈修改内容〉
 */

/**
 * 文件名：Log.**
 * 版权：***
 * 描述：**
 * 修改人：**
 * 修改时间：2019年9月27日20:28:01
 * 修改内容：新增
 * 修改人：**
 * 修改时间：2019年9月27日20:28:10
 * 修改内容：***
 * 修改人：**
 * 修改时间：2019年9月27日20:28:28
 * 修改内容：**
 */

函数头注释

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

/**
 * 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
  );
}

3 以#开始的单行注释

以PHP为例

# 声明一个$a变量
$a="json";
# 声明一个常量
const $b=5;
# 合法的常量名
define("FOO",     "something");
# 声明一个数组$array
$array = array(
    1    => "a",
    "1"  => "b",
    1.5  => "c",
    true => "d",
);

var_dump($array