草庐IT

java - Java 源文件末尾的空新行

coder 2023-05-13 原文

在我当前的项目中，我们总是在 Java 源文件的末尾插入一个空的新行。我们还使用 CheckStyle(带有错误级别)强制执行此操作。
我在这个话题上搜索了很长时间，但不幸的是我找不到任何令人信服的理由。其他开发人员似乎对此漠不关心，因为他们只是在 Eclipse 格式化程序中选中了一个复选框，并且它是自动完成的。但我仍然不知道为什么需要它以及为什么它很重要。所以我的问题是:
为什么需要 Java 源文件末尾的空行？
它是当前的需求还是过去的遗物并且在当前代码库中是不受欢迎的？

最佳答案

我认为他们试图确保每个文件都以尾随换行符结尾。这不同于以空行结尾，也就是空换行符。

编辑:正如@Easy Angel 在评论中简洁地阐明的那样:尾随换行符 = "\n"和空白行 = "\n\n"

我认为:

  • 您的领导要么强制每个文件以换行符结尾，但它被误解为强制每个文件以空行结尾(即以换行符结尾的空行)，否则
  • 他们试图通过实际强制每个文件以一个空行结尾(即以换行符结尾的空行)来确保每个文件都以换行符结尾，从而确保文件以至少一个换行符结尾(可能还有多余的额外换行符 - 矫枉过正？)。

    • 除非编辑器实际显示换行符，否则在某些编辑器中并不总是清楚文件:
  • 根本不结束换行，
  • 以单个尾随换行符结束，或
  • 以空白换行符结束，即 2 个尾随换行符

    • 我认为大多数现代源代码编辑器都会插入一个尾随换行符。但是，当使用较旧的更通用的编辑器时，我总是会尝试确保我的源代码文件(以及一般的文本文件)总是以尾随换行符结尾(根据我使用的编辑器，偶尔会出现一个空行/空换行符)使用)因为:
  • 使用时 cat要在命令行上显示文件，如果文件缺少尾随换行符，则下一个输出(如 shell 提示或脚本可能在文件之间输出的可视定界符)将最终出现在最后一个非换行符之后，而不是出现在最后一个非换行符之后从换行开始。通常，尾随换行符使文件对用户和脚本更友好。
  • 我相信如果文本文件缺少换行符，一些编辑器(我不记得任何细节)会自动插入一个尾随换行符。这将使它看起来像文件被修改了。如果您在不同的窗口中打开了一堆文件，然后将它们全部关闭，那会让人感到困惑 - 编辑器会提示您保存，但您不确定是对文件进行了“真正的更改”还是仅对文件进行了自动更改 -插入换行符。
  • 一些工具，如 diff并且一些编译器会提示缺少尾随换行符。这是用户和工具可能必须处理的更多噪音。


    • 编辑:

    关于编辑器添加换行符并且无法查看文件末尾是否有换行符与空白换行符，我刚刚测试了 Vim、Eclipse 和 Emacs(在我的 Windows 系统上使用 Cygwin):我打开了一个新文件，输入 ' h' 'e' 'l' 'l' 'o' 并保存而不按 [ENTER]。我用 od -c -t x1 检查了每个文件.
  • Vim 确实添加了一个尾随换行符。
  • Emacs 确实添加了一个尾随换行符。
  • Eclipse 没有添加尾随换行符。

    • 但
  • Vim 不允许我将光标向下移动到“hello”下的空白行。
  • Emacs 确实允许我将光标向下移动到“hello”下的空白行。
  • Eclipse 不允许我将光标向下移动到“你好”下的空白行。

    • 随心所欲地解释。

    我个人的做法是尽量确保文本文件以尾随换行符结尾。我只是觉得有 最少惊喜以人和工具配合就是如此。在这方面，我不会将源文件与文本文件区别对待。

    谷歌出现 this :

    其中，截至本次编辑，显示的点击量是关于来自 C 编译器、svn(由于差异)、差异等的丢失尾随换行符的警告。我觉得人们普遍期望文本文件(包括源文件)以尾随的换行符和最不令人惊讶的(和更少的噪音)，当它们倾向于在那里时。

    最后this很有趣:

    Sanitizing files with no trailing newline
    Text files should have all their lines terminated by newline characters (ie, \n). This is stated by POSIX, that says that a text file is

    A file that contains characters organized into zero or more lines.
    A line, in turn, is defined as
    * A sequence of zero or more non- characters plus a terminating character.



    然而 ，说了这么多，这只是我个人的做法。我很高兴与任何提出问题的人分享我的意见，但我不会强加给任何人。我不觉得这是值得强制执行的，就像我说的 here :

    While I'm one whose all for consistency, I'm also against micromanaging every bit of style. Having a huge list of coding conventions, particularly when some of them seem arbitrary, is part of what discourages people from following them. I think coding guidelines should be streamlined to the most valuable practices that improve the -ilities. How much is readability, maintainability, performance, etc improved by mandating this practice?

    关于java - Java 源文件末尾的空新行，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/4700312/

    新行末尾换行符尾随brjavacheckstyle

    有关java - Java 源文件末尾的空新行的更多相关文章

    1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

      我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

    2. ruby - 其他文件中的 Rake 任务 - 2

      我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

    3. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

      我的目标是转换表单输入，例如“100兆字节”或“1GB”，并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前，我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效，但前提是输入是倍数(“gigabytes”，而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以，功能正常，

    4. ruby-on-rails - Rails 3 中的多个路由文件 - 2

      Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情？ 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中，使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件，我们在StackOverflow上找到一个类似的问题

    5. ruby - 将差异补丁应用于字符串/文件 - 2

      对于具有离线功能的智能手机应用程序，我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

    6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

      我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

    7. ruby - 使用 Vim Rails，您可以创建一个新的迁移文件并一次性打开它吗？ - 2

      使用带有Rails插件的vim，您可以创建一个迁移文件，然后一次性打开该文件吗？textmate也可以这样吗？ 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件，这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails，您可以创建一个新的迁移文件并一次性打开它吗？，我们在StackOverflow上找到一个类似的问题： https://sta

    8. Ruby 写入和读取对象到文件 - 2

      好的，所以我的目标是轻松地将一些数据保存到磁盘以备后用。您如何简单地写入然后读取一个对象？所以如果我有一个简单的类classCattr_accessor:a,:bdefinitialize(a,b)@a,@b=a,bendend所以如果我从中非常快地制作一个objobj=C.new("foo","bar")#justgaveitsomerandomvalues然后我可以把它变成一个kindaidstring=obj.to_s#whichreturns""我终于可以将此字符串打印到文件或其他内容中。我的问题是，我该如何再次将这个id变回一个对象？我知道我可以自己挑选信息并制作一个接受该信

    9. ruby - 如何使用 Ruby aws/s3 Gem 生成安全 URL 以从 s3 下载文件 - 2

      我正在编写一个小脚本来定位aws存储桶中的特定文件，并创建一个临时验证的url以发送给同事。(理想情况下，这将创建类似于在控制台上右键单击存储桶中的文件并复制链接地址的结果)。我研究过回形针，它似乎不符合这个标准，但我可能只是不知道它的全部功能。我尝试了以下方法:defauthenticated_url(file_name,bucket)AWS::S3::S3Object.url_for(file_name,bucket,:secure=>true,:expires=>20*60)end产生这种类型的结果:...-1.amazonaws.com/file_path/file.zip.A

    10. ruby - rspec 需要 .rspec 文件中的 spec_helper - 2

      我注意到像bundler这样的项目在每个specfile中执行requirespec_helper我还注意到rspec使用选项--require，它允许您在引导rspec时要求一个文件。您还可以将其添加到.rspec文件中，因此只要您运行不带参数的rspec就会添加它。使用上述方法有什么缺点可以解释为什么像bundler这样的项目选择在每个规范文件中都需要spec_helper吗？ 最佳答案 我不在Bundler上工作，所以我不能直接谈论他们的做法。并非所有项目都checkin.rspec文件。原因是这个文件，通常按照当前的惯例，只

    随机推荐