Technique/Readable Code
-
3. 주석Technique/Readable Code 2015. 12. 9. 14:28
주석을 다는 목적은 코드를 작성하는 사람이 알고 있는 정보를 코드를 읽는 사람에게 전달하는 것 이다.코드에서 명확하게 드러나지 않는 내용이 무엇인지 파악하고 주석으로 처리하는 것 ■ 설명하지 말아야 할 것 - 코드 자체에서 재빨리 도출될 수 있는 사실 - 나쁜 함수명과 같이 나쁘게 작성된 코드를 보정하려고 애쓰는 주석 그렇게 할 시간에 코드를 수정해라 ■ 코드에 기록 해야하는 것 - 코드가 특정한 방식으로 작성된 이유를 설명해주는 내용 ( 감독의 설명 ) - 코드에 담긴 결함, TODO 혹은 xxxx같은 표시를 사용하라 - 특정 상수가 특정 값을 가지게 된 사연 - 코드를 읽는 사람이 자기가 작성한 코드의 어느 부분을 보고 뭐라고? 라는 생각을 할지 예측해보고, 그부분에 주석을 달 것 - 평범한 사람이 ..
-
2. 미학 - 읽기 편한 코드 작성Technique/Readable Code 2015. 12. 9. 10:59
■ : 요점▶︎ : 부가이익 ■ 코드를 읽는 사람이 이미 친숙한, 일관성 있는 레이아웃을 사용하라■ 비슷한 코드는 서로 비슷해 보이게 만들어라■ 서로 연관된 코드는 하나의 블록으로 묶어라 - 일관성과 간결성을 위해서 줄 바꿈을 재정렬하기 - 매소드를 활용하여 불규칙성을 정리하자 ▶︎중복된 코드를 없애서 코드를 더 간결하게 한다 ▶︎이름이나 에러 문자열 같은 테스트의 중요 부분들이 한 눈에 보이게 모아졌다. ▶︎새로운 테스트 추가가 쉽다. - 도움이 된다면 코드의 열을 맟춰라 - 의미 있는 순서를 선택하고 일관성 있게 사용하라 - 선언문을 블록으로 구성하라 - 코드를 문단으로 쪼개라 - 여러 블록에 담긴 코드가 모두 비슷한 일을 수행하면 실루엣이 동일 해 보이게 만들어라 - 코드 곳곳을 열로 만들어서 줄을..
-
1. 이름에 정보를 담아라Technique/Readable Code 2015. 12. 8. 11:58
■ 특정한 단어를 사용하라 - 상황에 따라 Get대신 Fetch나 Download를 사용하는 것이 나을 수 도 있다. ■ 꼭 그래야 하는 이유가 없드면 tmp 나 retval과 같은 보편적인 이름의 사용을 피하라 - 제일 뜨끔햇다... 변수명 선언에 신경 써야 겟다... ■대상을 자세히 묘사하는구체적인 이름을 이용하라 - ServerCanStart()는 CanListenOnPort()에 비해 의미가 애매 모호 하다 ■ 변수명에 중요한 세부 정보를 덧붙여라 - 예를 들어 밀리초의 값을 저장하는 변수 뒤에 _ms를 붙이거나 이스케이핑을 수행하는 변수 앞에 raw_를 붙이는 것 리턴 되는 값이 일정하거나 정해진 경우 _char라던지 _int라던지 붙여주면 좋을거 같다. 야리스기 해도 불편하지만 상황에 따라 ■..