注释格式示例

<?php
// +--------------------------------------------------------------+ //
// | JavaScript或PHP文件头部注释                                  | //
// +--------------------------------------------------------------+ //

/**
 * JavaScript或PHP函数作用说明
 * 备注:壹贰叁肆伍陆柒捌玖拾
 *
 * @param string $name  姓名
 * @param int    $age   年龄
 * @param array  $arr   数组类型
 * @param mixed  $mixed 任意数据类型
 * @return bool 检查结果
 */
function func($name, $age, $arr, $mixed)
{
    // TODO...
}

@charset "utf-8";
/* +--------------------------------------------------------------+ */
/* | CSS文件头部注释                                              | */
/* +--------------------------------------------------------------+ */

-- SQL注释
SELECT
  *
FROM
  `db`;

#!/usr/bin/env bash
# +----------------------------------------------------------------+ #
# | shell脚本文件头部注释                                          | #
# +----------------------------------------------------------------+ #

########## 个人信息 ##########
name='张三' # 姓名
age=18      # 年龄

Copyright © 2023 码农人生. All Rights Reserved