하, 하, 하, 가르치는 사람들이 GitHub의 프로젝트에 나쁜 코드를 작성하는 것을 불 ...

편집기 인간 거의

우리가 말한다면 좋은 코드가 무엇인지, 우리가 확실히 같은 일관된 형식과 들여 쓰기를 사용하는 등 규칙의 무리를 말할 수있는, 명확한 변수와 메소드 이름, 문서를 사용하고 필요 이상 코드를 간소화하지 않는 등 의견을 제공합니다.

그러나 나쁜 당신이 그것의 명확한 이해가 코드 무엇입니까?

GitHub의에서 새로운 프로젝트는의 "최고의 정크 코드"열 아홉 키 기준을 설명 있습니다. 변수 이름에서 댓글을 작성합니다. 이 지침은 당신이 나쁜 코드의 가장 매력적인를 작성 안내합니다.

원래 스타일 GitHub의 프로젝트, 늦어도 변환을 유지합니다. 독자는 반대 각도에서 우리가 완벽하게 피할 정크 코드를 작성할 수 있습니다 그래서, 모든 관점을 이해 할 수 있습니다.

프로젝트 주소 : HTTPS : //github.com/trekhleb/state-of-the-art-shitcode

물론, 코드를 작성 지침에 다음과 같은 아홉 쓰레기 독자 관행을 코딩 일부 참을 불량을 발견하면, 메시지는 귀하의 의견을 줄 수있는 모든 것을 커버하지 않습니다.

조 : 가능한 한 적은을 입력

적은 우리가 뭔가를 입력하면, 다음 코드 로직 및 기타 문제에 대해 생각하는 시간이있다. 아래와 같이, "좋은"는이 규칙을 따르도록 예를 나타내고, 나쁜 규칙을 따르도록하지 예를 나타냅니다.

제 II :변수 / 함수 이름 스타일이 혼합

우리는 명명법의 다양성을 반영하기 때문에 같은 이름의 변수와 혼합 할 필요가있다.

조 :의견을 작성하지 마십시오

어쨌든, 코드가 이해할 수, 왜 코멘트 쓰기? 또는, 어쨌든, 내 코드에서 아무도 왜 코멘트를 작성하지?

제 4 조 :모국어의 사용은 의견을 작성하려면

세 번째 규칙을 위반하는 경우, 적어도 쓰기 코멘트 모국어 또는 다른 언어를 사용해야합니다. 첫 번째 언어가 영어 인 경우에, 당신은이 규칙의 위반으로 간주 될 수있다. 프로그래밍 언어의 대다수가 영어이기 때문에, 왜 다른 언어에 대해 언급하지?

조 :다른 형식을 혼합 할 수

同样,为了代码的多样性,我们需要尽可能混合不同的格式,例如单引号或双引号。如果它们的语义相同,那就应该混用。

第六条:尽可能把代码写成一行

如果一系列参数与方法都是一起实现的,那么代码也要写在一起。

第七条:发现错误要保持静默

当你发现某些错误时,其他人不需要了解它,因此不需要打印出日志或 Traceback。

第八条:广泛使用全局变量

使用全局变量,是面向「全球化」不可或缺的部分。

第九条:构建备用变量

以防万一,我们需要创建一些备用变量,在需要时随时调用它们。

第十条:Type 使用需谨慎

一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型。

第十一条:准备「Plan B」

你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」。

第十二条:嵌套的三角法则

如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的。

第十三条:混合缩进

我们需要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进,那么就使用混合缩进策略。当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构。

第十四条:不要锁住依赖项

每一次要安装新库时,更新已有的依赖项。为什么要维持之前的版本呢,我们需要时刻保持最新的第三方代码库。

第十五条:长函数比短函数好

不要将程序整体逻辑分割为一些代码块,要是 IDE 突然不行了,它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中,并且不再维护额外的函数导入或代码文件,那么这样的方法是最稳定的。

单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。

第十六条:代码不需要做特定测试

这些测试通常是重复且无意义的工作。

第十七条:尽量避免重复代码

按你的想法写代码,尤其是在小团队中,毕竟这是「自由」准则。

第十八条:构建新项目不需要 README 文档

在项目前期,我们可以暂时保持这种状态。

第十九条:保存不必要的代码

在写代码的过程中,经常会产生很多测试代码。这些代码也是非常重要的资料,因此不能删除掉,最多只能注释掉。




有道无术,术可成;有术无道,止于术欢迎大家关注Java之道公众号好文章,我在看❤️
发布了99 篇原创文章 · 获赞 4232 · 访问量 83万+

추천

출처blog.csdn.net/hollis_chuang/article/details/104509265