Be Consistent

클린 코드의 법칙 중 하나로 일관성 있는 형식을 가진 코드를 만들라는 것입니다.
시스템 전체에서 일관된 명명 규칙, 데이터 구조, 인터페이스를 사용하는 것이 여기에 포함되고 또한 확립된 설계 원칙 및 모범 사례를 따르는 것도 포함됩니다.
일관성이 지켜지면 시스템을 더 유지보수하기 쉽고, 이해하기 쉽고, 확장이 쉬워집니다.

아래에서는 일관성을 유지하기 위한 방법을 알아보겠습니다.

Principles For Consistent

Follow Conventions

naming convention을 사용하는 것은 코드를 명확하게 해주며 코드가 무엇을 하고 있는지 확실하게 알게 해줍니다.
어떤 naming convention을 쓸 지는 사람들의 선호에 따라 드립니다.

아래는 naming convention의 예시로 맨 앞에 변수의 자료형을 나타내는 알파벳을 붙여서 쓰는 형식을 쓰고 있습니다.

Indicate Variable Scope

변수의 scope를 명시하는 것입니다.
예를 들어 아래에서는 private, public, constant 변수에 대해 다른 표기법을 사용하고 있습니다.

//private and protected variables are prefixed with an underscore 
int _iWindowSize = 900;

//public variables are left as they would be normally
int iWindowSize = 900;

//constant values are in all caps and separated with underscores
int I_WINDOW_SIZE = 900;

Say What You Mean

코드가 무엇을 의미하는지 알려주는 것입니다.

Whitespace

Whitespace를 사용하는 것은 가독성에 매우 큰 도움을 줍니다.
javascript같이 공백이 용량을 차지하는 것이 중요할 경우 whitespcae를 사용하고 다른 툴을 이용해 공백을 지우는 것이 좋습니다.

Add Commneting

설명을 덧붙이는 주석을 추가함으로써 복잡한 함수가 수행하는 작업을 빠르게 알려줄 수 있습니다.
또한 해당 코드가 해결하려고 했던 문제를 이해하고 더 나은 해결책을 찾는데 도움을 줄 수 있습니다.
그러나 너무 많은 주석 그리고 너무 오래된 주석은 가독성을 해치기 때문에 적절하게 사용하고 언제나 최신 상태를 유지해야 합니다.

Automate

중복된 작업을 간략하게 만든느 것은 중요합니다.
아래는 값을 할당하는 작업을 간략하게 만드는 예시입니다.
먼저 중복된 작업을 하는 예시를 보겠습니다.

위의 작업을 아래처럼 간략하게 만들 수 있습니다.

Rememeber the power of i

반복문에 변수 i를 사용하는 것이 좋습니다.

Similar Variables Together

하나의 클래스에 여러 개의 변수를 둬야 한다면 하나의 공간에 모아두는 것이 좋습니다. 특히 상단에 위치하는 것이 찾기 쉽습니다.

Keep it functional

코드 내에 있는 작업들은 가능한 함수로 분할해서 읽기 쉽게 만드는 것이 좋습니다.

Keep it Classy

Keep it functional원칙과 유사하게 클래스들로 분할해서 하나의 기능을 만드는 것이 좋습니다.