java中到底该不该用@author标识作者?

2023-11-15

今天查看activiti的README,突然发现一段很有意思的FAQ。

Why do you not accept @author lines in your source code?

    Because the author tags in the java files are a maintenance nightmare
        A large percentage is wrong, incomplete or inaccurate.
        Most of the time, it only contains the original author. Many files are completely refactored/expanded by other authors.
        Git is accurate, that is the canonical source to find the correct author.

    Because the author tags promote code ownership, which is bad in the long run.
        If people work on a piece they perceive as being owned by someone else, they tend to:
            only fix what they are assigned to fix, instead of everything that's broken
            discard responsibility if that code doesn't work properly
            be scared of stepping on the feet of the owner.

    Credit to the authors is given:
        with Open Hub which also has statistics
        in the GitHub web interface.

问题:为什么不在源码中使用 @author ?

首先,@author 是什么?

Java 文档注释标签。
其他常用的有:

@author 作者
@param 输入参数的名称 说明
@return 输出参数说明
@since JDK版本
@version 版本号
@see 链接目标
@throws 异常
@deprecated

为什么不用?

activiti作者认为:

  • 不利于java文件的后期维护。
  • 对于长久来说,为代码标明所有者是很糟糕的事情。
  • 代码版本工具提供了作者的提交历史记录,不需要再单独标识。

我觉得说的很有道理!

但是,公司内部的管理来说,有些人就是喜欢打上程序员的标签。
好吧,全世界的问题都是程序员的错!

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

java中到底该不该用@author标识作者? 的相关文章

随机推荐

  • 秋招笔试题——嵌入式软件开发

    某VO 给定一个非空字符串str 在最多可以删除一个字符的情况下 请编程判定其能否成为回文字符串 如果可以则输出首次删除一个字符所能得到的回文字符串 如果不行则输出字符串 false bool isSpecial char string i
  • C++ 类与对象 面向对象编程 继承

    https www bilibili com video BV1et411b73Z p 127https www bilibili com video BV1et411b73Z p 127 继承是面向对象三大特性之一 我们发现 定义一些类时
  • WordPress计数插件

    这几天在折腾这个blog 无非是加些插件改点代码 折腾的成果基本就是大家看到的这样了 可能国外用户不关心post的访问人数 WP基本功能里没有显示多少个views的功能 这时候就需要WP PostViews插件帮忙 我的WP版本比较高 安装
  • java中的异常 最详细的讲解

    一 异常的概念 异常 在程序执行的过程中 出现的非正常情况 最终会导致JVM非正常停止 在Java等面向对象的编程语言中 异常本身是一个类 产生异常就是创建异常对象并抛出了一个异常对象 Java处 理异常的方式是中断处理 异常指的并不是语法
  • Nginx基本入门

    本文转载至 http blog csdn net u012486840 article details 53098890 1 静态HTTP服务器 首先 Nginx是一个HTTP服务器 可以将服务器上的静态文件 如HTML 图片 通过HTTP
  • [leetcode] 适合打劫银行的日子 -前缀和

    题目链接 前缀和思想 用数组 l l l 表示前面有多少个数满足 a i
  • MySQL----内置函数

    MySQL gt 内置函数 函数 将经常使用的代码封装起来 需要的时候直接调用就可以 从函数定义角度 函数可分为 内置函数 系统内置的通用函数 自定义函数 需要根据需求编写的函数 MySQL提供的内置函数从实现的功能角度可以分为数值函数 字
  • 多益视频面试

    多益面试 有一种怀疑人生的感觉 向老师 我对不起你 去年刚学的网络安全 我竟然没说出来加密算法的名字 也并不是题很难 而是简单的就是说不出来 写不出来 而难的也就是听过而已 问题 1 说一下什么是线程安全 线程安全的场景 线程安全就是确保程
  • 单相机做分屏混合

    做了一个单相机实现分屏混合的功能 需求大概就是在同一视角下 相机通过不同的CullingMask获取不同的渲染图片RenderTexture之后 通过某种方式一起显示在界面的功能 其实核心逻辑就是怎样用一个相机渲染不同的图片罢了 直接上代码
  • 在Java中,将ExecutorService转为守护程序

    问题描述 我正在Java 1 6中使用一个ExecutoreService 简单地开始 ExecutorService pool Executors newFixedThreadPool THREADS 当我的主线程完成 以及由线程池处理的
  • vue调用原生方法交互

    目前在做一个H5应用 需要调用原生方法进行交互 特此做一个记录 技术栈 vue版本2 6 vant版本 2 12 第一步 声明一个rpcFn js文件 进行原生交互阿里桥封装 const rpc function url params re
  • github actions实现Android持续集成

    持续集成 Continuous Integration 在很多单位都有现成的系统 但是作为一名工程师 我们还是要了解其原理 可以自己尝试做一下 经过本人的尝试 发现功能并不复杂 这里把持续集成实践经验总结与大家分享 持续集成用的比较多的是j
  • 2023自动化专业毕业设计项目集合

    文章目录 1前言 2 如何选题 2 1 物联网方向 2 2 嵌入式开发方向 2 3 人工智能方向 2 4 算法研究方向 2 5 学长作品展示 4 最后 1前言 近期不少学弟学妹询问学长关于自动化专业相关的毕设选题 学长特意写下这篇文章以作回
  • 基于springcloud gateway + nacos实现灰度发布(reactive版)

    什么是灰度发布 灰度发布 又名金丝雀发布 是指在黑与白之间 能够平滑过渡的一种发布方式 在其上可以进行A B testing 即让一部分用户继续用产品特性A 一部分用户开始用产品特性B 如果用户对B没有什么反对意见 那么逐步扩大范围 把所有
  • 一个网站引发的程序猿的牢骚,哈哈哈

    2013年大学毕业后 参加工作做的第一个前端项目 北京服装学院 今天调研一个关于iframe的需求 突然想试试 以前那些做IE6兼容的项目是否还在使用 就默默的点开了 十年了 他们没有换网站 我的岁月似乎从这一刻又回来了一次 已经十年了 我
  • Flask学习笔记(二)

    Flask学习笔记 二 1 知识点 1 1虚拟环境 1 1 1virtualenv 1 1 2virtualenvwrapper 1 2web与视图 1 3jinja2 1 3 1template知识点 1 3 2豆瓣列表页 1 3 3视图
  • 锚框损失论文下载 Iou-Loss【IoU Loss、GIoU Loss、 DIoU Loss 、CIoU Loss、 CDIoU Loss、 F-EIoU Loss、α-IoU Loss】

    锚框损失 Iou Loss IoU Loss GIoU Loss DIoU Loss CIoU Loss CDIoU Loss F EIoU Loss IoU Loss 论文打包下载 yolo系列论文https download csdn
  • cocosCreator2.3.x渲染流程深入剖析笔记(三)

    渲染批次合并之顶点 根据前面说过的render flow流程接下来就是重头戏了render流程 其中包括了 检查两个渲染节点是否可以合并 同时把renderData的数据填充到modelBatch里的buffer中去 所有需要渲染的节点都有
  • Kotlin中匿名函数(又称为Lambda,或者闭包)和高阶函数的详解

    博主前些天发现了一个巨牛的人工智能学习网站 通俗易懂 风趣幽默 忍不住也分享一下给大家 点击跳转到教程 1 匿名函数 fun main 匿名函数 1 定义时不取名字的函数 我们称之为匿名函数 匿名函数通常整体传递给其他函数 或者从其他函数返
  • java中到底该不该用@author标识作者?

    今天查看activiti的README 突然发现一段很有意思的FAQ Why do you not accept author lines in your source code Because the author tags in the