关于简单起见,用拼写错误重新定义Java方法的名称

时间:2011-01-27 21:49:16

标签: java

我输入速度很快,并且通常会在打印时不断修复打字错误。例如,如果我使用方法 getCompany(),我经常把它写成 getComapny(),这让我非常恼火。是否认为将 getCompany()方法包装到 getComapny()中不再打扰这个错字是一种好习惯?喜欢

public Company getCompany(){
  Company company = new Company();
  //do some really important stuff in here
  return company;
}

并用

包装
public Company getComapny(){
  return getCompany();
}

我认为在我之后会支持这些代码的同事会感激不尽,他们也有同样的问题。

BTW,如何从JavaDoc隐藏 getComapny()只显示 getCompany()

7 个答案:

答案 0 :(得分:15)

在MSOffice中将拼写错误添加到词典中会不会很好,所以你看不到这么多的红线。

其他人应该能够阅读你所说的内容。

糟糕的主意。

答案 1 :(得分:6)

我真的希望这篇文章是个笑话。我很遗憾将来必须维护该代码的穷人。你想支持多少拼写错误?

public Company getComapny(){
public Company getCmopany(){
public Company getCompayn(){
public Company getCoampny(){
public Company getCimpany(){
public Company getCimapny(){
public Company getCimapyn(){

特别是当任何体面的IDE都有CTRL-SPACE自动完成方法名称之类的东西时。哪个更快比自己实际输入方法名称。 请告诉我这是一个笑话。我认为我的大脑正在融化。

答案 2 :(得分:2)

快速键入很多拼写错误根本不打字,输入速度很慢。非常慢,考虑到修正周期。

减速并加快速度。

不要在应用程序中构建自己的个人错误。带他们 out。

答案 3 :(得分:1)

  

它被认为是一种好习惯   将getCompany()方法包装进去   getComapny()不要为此烦恼   错字了?

我认为你不会比这更糟糕。看看Logback news。新版本打破了与先前版本的兼容性,因为有一个拼写错误的字母(0.9.28之前的版本有“bithTime”而不是“birthTime”)。你自己也应该这样做。将拼写错误的方法的每个实例重命名为正确的方法并强制用户使用新版本。

解决现有问题只会使其从长远来看变得更糟,维护明智。

顺便说一下:投入更多时间进行正确打字。你可以成为世界上最快的人,但如果你在每一句话中都犯错误,你的速度对你没有多大帮助。

答案 4 :(得分:1)

你建议犯一个错误(错字)而不是消除错误,允许它传播。未被编译器拒绝的代码往往被复制/粘贴,用作示例等等。过了一段时间,不管是否存在于“官方”文档中,错别字都将遍布整个地方。

更不用说任何会对应该使用的“正确”名称感到困惑的新手。有很多人不得不解决遗留在遗留代码中的错误标识符 - 这些人在常规使用拼写错误的名称时看不到任何异常。

简而言之:除非你已经拥有大量无法合理转换的遗留代码,否则你不应该让拼写错误传播,更不用说将它们作为理所当然的介绍了。

答案 5 :(得分:0)

不要做类型-o。那太烦人了。 也许你应该调用方法createCompany(),或buildCompany(),或者其他一些构建器/工厂(取决于在注释掉的部分中做了什么)标准。

至于隐藏它,我所知道的唯一方法是将该方法设为私有。

答案 6 :(得分:0)

像上面解释的那样包装代码,将getComapny方法标记为已弃用,并尽快将其删除。

除非您的代码是外部发布的并且需要保持兼容性,否则请对所有代码进行签名更正,几乎任何IDE都没有。猜猜你会更快乐。

但是,一个拼写错误可能看起来很糟糕,但如果代码本身很好,它只会打扰编码员。如果你在谈论意大利面条代码,没有人会关心拼写错误。