JavaScript中是否有标注代码作者、日期、来源的通用规范？

可机器识别的主流标注标准 #

目前行业内有多个被工具链广泛支持的通用标注规范，所有规范都采用@标签名的格式定义元数据，IDE、文档生成工具、静态分析工具都可以直接解析提取相关信息：

• JSDoc/TSDoc：适用于JavaScript、TypeScript生态，是前端、Node.js领域的通用标准，使用/** */包裹的注释块承载元数据
• Doxygen：支持C、C++、Java、Python、Go等绝大多数编程语言，通用性最强，除了生成接口文档外，很多代码质量检测工具也会识别其标签
• SPDX许可证标注：涉及版权的外部代码必须遵循的机器识别标准，可直接标注代码对应的开源许可证类型，避免版权纠纷

外部引入代码的标注要求 #

对于来自StackOverflow等公开平台的代码片段，必须标注溯源、作者、许可证三类核心信息，示例如下（以JavaScript为例，其他语言适配对应注释规范即可）：

/**
 * 生成字符串的32位哈希值
 * @source StackOverflow 对应问题链接
 * @author StackOverflow 用户昵称
 * @license CC BY-SA 4.0
 * @modified 2024-06-10 （如果对原代码有修改可补充该标签）
 */
function getHash(str) {
  // 具体代码逻辑
}

所有标签都是机器可识别的，静态检测工具可以直接提取溯源信息，避免版权风险。

自有代码的署名标注规范 #

自己编写的函数可以直接使用通用标签添加个人信息，这些信息会在IDE悬停提示、自动生成的接口文档中直接展示，示例如下（以Python为例）：

def calculate_total_sales(monthly_data, extra_revenue):
    """
    计算年度总销售额
    @author 你的署名
    @date 2024-05-20
    @website 你的个人站点地址
    @version 1.0.1
    @param monthly_data: 月度销售数据列表
    @param extra_revenue: 额外非主营业务收入
    @return: 年度总销售额
    """
    return sum(monthly_data) + extra_revenue

无需自定义特殊格式，使用上述通用标签即可满足绝大多数场景的机器识别需求，也符合行业通用惯例。

内容的提问来源于stack exchange，提问作者user3371597