가독성 있는 코드를 위한 5가지 팁

나는 학생들이 코딩을 할 수 있어야 하는 석사 과정에 참석하고 내 반 친구들 중 일부는 이 세계를 경험하지 못했습니다. 코드의 가독성을 높이는 데 도움이 되는 5가지 간단한 팁을 제공합니다.

하지만 읽을 수 있는 코드는 무엇입니까? 누군가는 그것을 누군가가 언젠가는 당신의 코드를 유전할 것이고 그 사람에게는 새로운 기능을 수정하거나 추가하는 꿈이나 지옥이 될 것이라는 기본적인 의식으로 정의할 수 있습니다. 그래서 당신은 사람들이 당신이 코딩한 것을 더 쉽게 이해할 수 있기를 바랍니다 방법, 그래서 팁:

1. 명명 체계가 무엇인지 정의

변수, 상수 및 메서드에 대해 서로 다른 명명 체계가 있으며 무엇을 선택하든 상관없지만 모든 코드를 통해 이를 고수해야 합니다. 가장 많이 사용되기 때문에 제가 가장 추천하는 2가지 체계는 다음과 같습니다.

camelCase: getUserInformation()과 같이 첫 번째 단어를 제외하고 각 단어의 첫 글자가 대문자입니다.

밑줄: get_user_information()과 같이 단어 사이에 밑줄을 긋습니다.

2. 가능하면 개체를 사용하십시오.

변수보다 개체를 선택할 수 있는 기회가 있는 경우 항상 개체 경로를 선택하십시오. 예를 들어 드리겠습니다. 기능에 처음 접근할 때 사람의 이름과 성을 수신하기만 하면 됩니다. 저장하려는 것인데 이제 생년월일도 저장해야 한다면?? 객체 경로를 선택한 경우 생성한 객체에 새 변수를 추가하기만 하면 되지만 코드의 각 부분에서 해당 사람의 정보가 필요한 부분에 추가하지 않았다면 이제 변수를 추가해야 합니다.

////BAD
void savePerson(string namePerson, string lastNamePerson , dateTime birthDate){
  ...
}

////GOOD
void savePerson(Person person){
  ...
}

3. 항상 항상 포맷!!

탭이나 공백을 사용했는지 여부는 중요하지 않지만 항상 실제로 구성된 방식으로 서식을 지정합니다. 개인적으로 언어에 따라 다를 수 있으므로 코드 스니퍼와 IDE에서 사용할 수 있는 서식을 사용하는 것이 좋습니다.

4. 함수는 한 가지만 수행해야 합니다.

함수에 500줄 이상을 사용하지 말라는 규칙에 대해 들어보셨을 수도 있지만 특히 백엔드에서 실용적인 규칙은 아니라고 생각합니다. 제가 적용하고 싶은 규칙은 각 함수가 다음 작업만 수행해야 한다는 것입니다. 한 가지, 아마도 그것을 달성하기 위해 다른 함수를 호출해야 할 필요가 있을 것입니다. 그러나 결코 스스로 해서는 안 됩니다. 이를 적용하면 중복 코드를 피하고 함수를 테스트하고, 작성하고 추론하는 것과 같은 많은 이점이 있습니다.

////BAD
function notifyGroups(groups) {
  groups.forEach(group=> {
    const listenerRecord = database.lookup(group);
    if (listenerRecord.isActive()) {
      notify(group);
    }
  });
}
////GOOD
function notifyActiveGroups(groups) {
  groups.filter(isListenerActive).forEach(notify);
}

function isListenerActive(group) {
  const listenerRecord = database.lookup(group);
  return listenerRecord.isActive();
}

5. 더 적은 수의 댓글을 더 나은 이름으로 지정

우리 커뮤니티에는 "가장 좋은 댓글은 절대 쓰지 않는 댓글입니다"라는 말이 있지만 저는 그 접근 방식을 별로 좋아하지 않기 때문에 3가지 문구로 다시 시작할 수 있다는 Jason McCreary 철학에 동의합니다.

글이 나쁘거나 불필요한 댓글보다는 노코멘트가 낫다

설명해야 할 코드를 개선해야 하므로 먼저 코드를 리팩토링하고 더 나은 이름을 지정하십시오.

댓글은 악마가 아니며 때로는 정당화되기도 합니다. 예를 들어 비즈니스 규칙을 설명할 때.

읽어 주셔서 감사합니다!