代码中的注释页眉和页脚真的有必要吗? [关闭]

2024-01-08

许多公司编码标准要求每个文件中都有大量的注释页眉和页脚。就像是:

// MyFile.cpp
//
//  Copyright (c) 200x Company ABC
// 
//  This file is a copyrighted... blah blah blah
//

<... some code ...>

// Copyright (c) 200x Company ABC
//
//  Change history:
//     1.0  -  Blah
//     1.1  -  Blah, blah..

所以,问题是——为什么我们需要这个?这真的有必要声明文件内容的版权吗?或者这是一种已成为标准的误导性做法? 有人在不需要这样的公司工作吗?


首先,更改历史记录毫无意义,请使用您的 SCM。

A copyright statement is not strictly required (copyright is automatic)1, but if you are publishing source then likely including it will be felt to be safer2. The full licence statement would probably be better in a separate file and then referenced (this is what Boost http://www.boost.org/users/license.html#FAQ does).

1 Wikipedia http://en.wikipedia.org/wiki/Copyright has a reasonable summary, but you really need to take your own legal advice.

2 Especially by lawyers playing it safe.

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

代码中的注释页眉和页脚真的有必要吗? [关闭] 的相关文章

  • 使我的文件可读为 Perl 或 HTML

    本着 Perl 序言 https stackoverflow com questions 2308874 explain the deviousness of the perl preamble 无论是由 shell 脚本解释器还是 Per
  • 扫描代码注释并转换为标准格式的工具[关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在开发一个 C 项目 该项目有许多不同的作者和许多不同的文档风格 我是以下的忠实粉丝doxygen
  • PHP:如何跳过注释?

    好吧 如果我评论某些内容 它在所有语言中都会被跳过 但是它们是如何跳过的以及读取的内容是什么 Example This is commented out 现在 PHP 是读取整个注释以转到下一行还是只读取 该脚本被解析并分为tokens 实
  • Visual Studio 2017 中的注释样式

    我想在Visual Studio 2017中选择一段代码并对其进行注释 我知道我可以使用 CTRL K C 但结果是 fstream in c users hp documents visual studio 2017 projects i
  • 如何在 Django 中添加对评论的回复?

    我正在用 Django 制作自己的博客 并且我已经制作了一个评论系统 我想为每个评论添加回复 就像普通的评论框 但我不知道该怎么做 这是我当前的 models py评论 class Comment models Model post mod
  • Python如何在使用Python写入新值后保持XML注释存在?

    我有一个 XML 文件 然后需要更新一些值 我的 XML 文件包含注释 我想在编写 XML 后保留注释 但它消失了 这是我的 XML
  • 如何向 Exuberant Ctags 配置文件添加注释?

    我可以使用什么字符在 Exuberant Ctags 中发表评论 ctags file 我想添加注释和解释 也许还可以禁用一些正则表达式 但我找不到 ctags exuberant 接受的任何评论字符 我不断收到警告 ctags Warni
  • FB.event.subscribe comment.create 无需用户操作即可执行操作[重复]

    这个问题在这里已经有答案了 好的 这就是我的问题 我试图在 Facebook 评论中发表评论后向个别帖子的作者发送一封电子邮件 以通知作者已发表评论 评论框位于 K2 项目中 在 Joomla 中 FB event subscribe co
  • 在快速帮助文档注释中添加 Swift 类的链接?

    假设我有两个课程 This class should be used together with Foo class Bar func doNothing Description of what Foo does goes here cla
  • 是否可以通过 JavaScript 获取对评论元素/块的引用?

    这听起来有点疯狂 但我想知道是否可以引用注释元素 以便我可以用 JavaScript 动态地将其替换为其他内容 div div div div 在上面的页面中 我可以引用评论块并将其替换为本地存储中的某些内容吗 我知道我可以有一个 div
  • 忽略 doxygen 注释块中的行

    是否可以在 doxygen 注释块中包含将被 doxygen 忽略的内容 换句话说 我们可以在 doxygen 评论块中发表评论吗 背景 我们正在将 Fortran 项目的代码内注释转换为 doxygen 可解析的格式 但是该项目要求代码内
  • 在哪里记录 C 或 C++ 中的函数? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我有一个包含多个文件的 C 程序 所以我有 例如 stuff c它实现了一些功能 并且stuff h与函数原型 我应该如何在注释中记录功能 我应
  • 防止 Google Play 上的虚假评论 [关闭]

    Closed 这个问题是无关 help closed questions 目前不接受答案 我将 Android 应用程序发布到 Google Play 一切都很好 我收到了大约 5000 条用户评论 平均分为 4 6 分 但在某个时刻 我开
  • 获取 Disqus html 代码以显示在源代码中以实现 SEO 目的

    最近开始在网站上使用 Disqus 想知道是否有任何方法可以让实际的 html 代码显示在源页面中 我注意到这个网站正在这样做 http adamkaras com blog 2009 06 24 disqus custom css sty
  • Emacs 中的 C 注释 - Linux 内核风格

    我在用着 setq default comment style multi line and my region comments when doing M are void main int i int b printf format s
  • 删除 VB.NET 源代码文件中的所有注释

    Visual Studio 编辑器中是否有宏可以删除 VB NET 源文件中的所有注释 使用菜单编辑 gt 查找和替换 gt 使用正则表达式快速替换 找什么 用 来代替 1 将取代 text comment to text
  • #ifdef MACRO 相当于注释吗

    假设 MACRO 没有定义 这些是等价的 ifdef MACRO Not valid C or C code endif Not valid C or C code 在 GCC 4 7 1 中 它似乎是等效的 但是否有预处理器可以做更多的事
  • 如何在 Visual Studio 2010 中处理 TODO 注释?

    我希望 Visual Studio 列出开头包含 TODO 的所有行 通常在注释符号之后 注释符号可能会根据文件类型而变化 这些行可以在解决方案中的任何文本文件中找到 无论是 C VB F T SQL ASPX XAML 或只是 TXT 在
  • jsf 2.0 中看不见的注释? [复制]

    这个问题在这里已经有答案了 是否可以在我的 xhtml 文件中嵌入注释 这些注释仅显示在源代码中 而不显示在渲染结果中 我想在文件中包含作者 日期 但最终用户在生成的输出中不应该看到它们 如果我使用标准评论标签浏览器显示它们 将以下内容添加
  • aspx/ascx 文件中的 Visual Studio TODO 注释是否可以出现在任务列表中?

    我们使用 Visual Studio 2008 开发 asp net Web 表单 为了获得多语言支持 我们翻译所有文本 然而 在设计时 我们通常只是输入英文文本 然后再返回翻译 否则会中断工作流程 我在选项中添加了 ToTranslate

随机推荐

  • Nginx“ssl_stapling”被忽略,在 OCSP 响应程序“ocsp.comodoca.com”中找不到主机

    我正在尝试在 Nginx 上设置 OCSP 装订 我收到错误 ssl stapling ignored host not found in OCSP responder ocsp comodoca com 这是文件 conf server
  • 如何在 JavaScript 中从 URL 获取 JSON?

    返回 JSON query count 1 created 2015 12 09T17 12 09Z lang en US diagnostics 我尝试了这个 但没有成功 responseObj readJsonFromUrl http
  • ViewModel 无法在 Activity 中实例化

    我正在尝试实例化一个 ViewModel 以在我的所有 Activity 中使用 public class LaunchActivity extends Activity private Controller control Overrid
  • Visual Studio 2017 Team Services:可以登录github帐户,但无法推送更改

    我一直在尝试通过 Visual Studio 2017 Team Services 在我的笔记本电脑上设置 github 它让我首先登录 甚至让我将存储库克隆 分叉到本地文件夹中 问题是每次我尝试推回 github 时都会出现以下错误 推送
  • 在 mysql 中使用 group by 仅选择最后一个值

    我有一张表 其中包含有关参加某些活动的数据 我在表中记录了用户每次发送新考勤时的考勤数据 信息如下 mysql gt SELECT id branch channel id member attendance timestamp id me
  • 如何从闪亮的 ggplotly 中获取数据行

    代码如下 我正在尝试使用plotly click事件来确定正在选择哪些数据 但是 我不知道该怎么做 plotly click 提供的数据非常少 根本不包括分组 我没有任何JS经验 但我知道一定有办法 我的目标是能够选择一个数据点并能够抓取它
  • 如何将 Scripting.FileSystemObject 标记为脚本安全?

    介绍 我正在为数控机床编程 确切地说是比雅斯的漫游者 用于编程的软件编辑器支持VBScript VBScript 用于实现条件语句和循环等 在软件说明中 我列出了 VBScript 中标记为不使用的所有语法 以避免复杂化 当然 我想使用 V
  • 在某些静态库中打开整个程序优化会大大增加库的大小!

    在 Visual Studio 2010 中 我有一个 C C 静态库项目 当我打开该选项时整个程序优化 in release模式下 我获得了超过 90 MB 的 lib 文件 当我关闭此选项时 大小会减少到 24 MB 该库包含数百个使用
  • 复制赋值运算符=自赋值检查错误

    如果我有一个类声明为 class Person public Person const int age constructor Person const Person other Person operator const Person o
  • 如何将 Excel 中的值限制在某个范围内?

    在 C 中我会使用boost clamp为了这 基本上我有一些excel函数 A1 B2 C3 D4 我想将其限制为 某个数字 称之为X1 显而易见的方法是这样的 MAX X1 MIN X1 A1 B2 C3 D4 但我希望能够做到这一点
  • Hive-Tez 上的 Map-Reduce 日志

    我想在 Hive Tez 上运行查询后获得 Map Reduce 日志的解释 INFO 后面的几行传达什么 这里我附上了一个样本 INFO Session is already open INFO Dag name SELECT a Mod
  • 使用 TPL 时如何在 UI 线程上调用方法?

    我正在开发一个 MVVM 应用程序 它使用 TPL 在后台执行多项任务 任务需要向 UI 报告进度 以便可以更新进度对话框 由于应用程序是 MVVM 因此进度对话框绑定到名为 Progress 的视图模型属性 该属性由具有签名的视图模型方法
  • JavaFX 拖放到 GridPane?

    我已经为我的游戏实现了拖放功能 但到目前为止我只能 拖放到 硬编码的位置 如图所示 我想要的是 当船舶被放下时 它的 x y 值 相对于 GridPane 被保存 或者 飞船掉落到的单元格被保存 我的 setOnDragDropped 事件
  • Jenkins gerrit 触发器在构建时未获取我的更改

    我已经使用 gerrit 触发器插件配置了 jenkins 以验证我们推送到 gerrit 的每个提交 我希望这个触发器包含我对原始存储库的最新更改并进行构建 但是 它仅克隆回购项目并进行编译 而无需我进行更改 以下是我在詹金斯中对 ger
  • 如何运行快照插件

    当我尝试使用以下命令运行下面的 Maven 插件时 com wordpress pomfromjarmavenplugin generate 0 0 1 SNAPSHOT generatepom 我收到此错误 下载中 https oss s
  • 如果数字以 1 结尾做某事

    我想做这样的事情 if day 1 day 11 day 21 day 31 day 41 result dan else result dana 我怎样才能对每个以 1 结尾的数字做到这一点 当然又不写出所有数字 只需检查除以 10 的余
  • 始终使用 Serilog 记录上下文数据

    我正在使用 Serilog 进行日志记录 对于每个日志 我想记录上下文信息 例如用户名和其他一些上下文信息 所以我用静态方法创建了包装器 如下所示 public static class MyLogger public static voi
  • Windows .cmd 标准输出 - 多重重定向

    给定一个 windows cmd 文件abc cmd abc cmd gt output log 上述命令行操作会将执行的输出保存到output log 文件中 是否有选项可以运行此命令以创建此日志的多个副本 也就是说 我希望在一个位置创建
  • highcharts 不尊重我的 x 轴日期间隔

    几周以来 我每 15 分钟收集一次一系列数据 不幸的是 中间有一个星期的数据缺失 这只是我的一个事实 当我使用 Highcharts 绘制这些数据的图表时 它会压缩 x 轴 时间 从而使图表倾斜 例如 x 轴每 2 小时就有一次主要刻度 直
  • 代码中的注释页眉和页脚真的有必要吗? [关闭]

    就目前情况而言 这个问题不太适合我们的问答形式 我们希望答案得到事实 参考资料或专业知识的支持 但这个问题可能会引发辩论 争论 民意调查或扩展讨论 如果您觉得这个问题可以改进并可能重新开放 访问帮助中心 help reopen questi