본문 바로가기

cleancode3

코드에 메모하는 법 - 주석(Comment) 주석은 코드 내에 작성하는 메모라고 생각하면 된다. 주석 처리된 부분은 프로그램이 해석하지 않는다. 사용자와 프로그램에겐 노출되지 않는 부분, 즉, 개발자들을 위한 장치인 것이다. 프로그램이 클 수록 코드를 알아보기가 어려워진다. 특히 협업하는 경우, 주석으로 다른 개발자들을 도와줄 수 있다. 다른 개발자뿐만 아니라, 자신에게도 마찬가지다. 예를 들어, 테스트 코드나 임시로 작성된 코드가 있을 때, 이걸 주석으로 알려주면 좀 더 빠르게 코드를 이해할 수 있을 것이다. 프로그래밍 언어마다 주석 처리하는 방법이 조금씩 다르다. 아래로 HTML, CSS, JavaScript, Java의 주석 처리 방법에 대해 정리하였다. 1. HTML 1) HTML은 다음과 같이 주석을 처리한다. 로 닫는다. 이 사이에 들어.. 2020. 1. 2.
이클립스에서 코드 들여 쓰기 탭 확인하기 (+ 코드 스타일 적용까지) edwith 부스트코스 웹 프로그래밍 강의를 듣고 있다. 부스트코스는 강의 챕터가 끝날 때마다 프로젝트가 주어지고, 프로젝트를 제출하여 현업 개발자분들에게 리뷰를 받아볼 수 있는 서비스가 있다. 그런데, 최근 제출한 프로젝트 코드 리뷰에서 코드 들여 쓰기 기준이 일정치 않다는 피드백이 왔다. (참고: [부스트코스] 웹 프로그래밍 프로젝트4-1) 이건 전에도 받아본 적 있던 거라 좀 민망했다. 들여 쓰기 잘해야 된다고 알고는 있었는데, 처음 지적받았던 그 리뷰 덕에 회사마다 코드 포맷 표준이 달라 tab 크기가 달라질 수 있다는 것도 알게 되었다. 그런데 똑같은 실수를 하다니ㅜㅜ (사진 속 코드에서 ······ 이 스페이스, →이 탭이다.) 항상 탭으로 들여 쓰기를 하지만, 다른 데서 코드를 짜 보고 복사.. 2019. 8. 18.
컴퓨터뿐만 아니라 사람도 이해할 수 있는 클린 코드 클린 코드란 가독성 좋은 코드를 말한다. 기능이 복잡할수록 코드도 복잡해지고 지저분해지기 쉽다. 동시에 기능이 복잡한 프로그램은 여러 명의 개발자가 함께 개발해야 하거나 여러 기능을 지속적으로 수정하고 추가해야 할 상황이 많다. 그래서 코드는 최대한 사람들도 이해하기 쉽도록 만들어야 한다. 1. 코딩 컨벤션(coding convention) 따르기 함수나 변수 등의 이름을 짓는 규칙을 말한다. 함수의 이름은 목적에 맞게 지어져 있어야 한다. 함수에 있는 내용이 이름과 어울리도록 하나의 로직을 담고 있어야 한다. 함수는 동사+명사로 이루어져 있어야 한다. 함수의 이름은 카멜 표기법 또는 _를 중간에 사용하여지어야 한다. (보통은 카멜 표기법을 많이 사용한다) 변수는 명사이며 의미 있는 이름으로 지어야 한다.. 2019. 8. 9.