分享

垃圾代码应该怎么写?GitHub这份垃圾代码书写准则,请收好!

 小样样样样样样 2022-08-22 发布于北京

好的代码可以像诗一样优雅,然而并非人人都能写的一手好代码!老实说,想写一手不被同事吐槽的代码确实不容易,

特别是有的小伙伴在工作中公司都没有明确的代码规范,或者仅仅只是一些口头约定,这样就更难养成一些良好的代码书写习惯了。

不过 IDEA 中有一个 Alibaba 代码规范插件,可以自己装着起一个约束提醒自己的作用。

 


 

最近小编在 GitHub 上看到一个开源项目,还挺有意思的,作者罗列出了什么样的代码是垃圾代码,仓库地址如下:

> > > h删ttp删s://删git删hub删.com删/trek删hleb/删stat删e-of-th删e-art-s删hitc删ode

 以一种容易造成代码混淆的方式命名变量

命名越短,就需要越多的时间去思考代码逻辑等问题。

Good

inta =42;

Bad

intage =42;

变量/方法命名风格不统一

为风格不统一干杯。

Good

intwWidth =640;

intw_height =480;

Bad

intwindowWidth =640;

intwindowHeight =480;

不写注释

反正没人能读懂你的代码。

Good

intcdr =700;

Bad

注释应该包含一些“为什么”,而不是一些“是什么”。如果代码连是“什么”都表达不清楚,那代码也太烂了。

//700ms的数量是从UXA/B测试结果中得到的一个经验值。

//@查看:<详细解释700的一个链接>

intcallbackDebounceRate=700;

使用母语写注释

如果你的母语是英语,那么请忽略这条准则。

Good

// Закриваємо модальне віконечко при виникненні помилки.

toggleModal(false);

Bad

// 隐藏错误弹窗

toggleModal(false);

PS:如果英语书写能力不是很强的话,建议还是用母语吧。毕竟说清楚总比说不清楚要强。

声明变量的风格不统一

再次为风格不统一干杯。

Good

String[] i1 = {"沉","默","王","二"};

Stringi2 [] = {"沉","默","王","三"};

Bad

String[] wanger = {"沉","默","王","二"};

Stringwangsan [] = {"沉","默","王","三"};

尽可能把代码写成一行

Good

IntStream.range(1,5).boxed().map(i -> { System.out.print("Happy Birthday ");if(i ==3)return"dear NAME";elsereturn"to You"; }).forEach(System.out::println);

Bad

for(inti =1; i <5; i++) {

System.out.println("Happy Birthday "+ (i ==3?"dear NAME":"to you"));

}

对错误信息不管不顾

无论什么时候发现错误,都没有必要让其他人知道。

Good

try{

// 意料之外的情况。

} catch (error) {

  // tss... 

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多