출처: https://insight-bgh.tistory.com/290
[Clean Code] 주석 작성 방법
나쁜 코드에 주석을 달지 마라. 새로 짜라 - 브라이언 W. 커니핸. P.J. 플라우거 - 잘 달린 주석은 유용합니다. 하지만 근거 없는 주석은 코드를 이해하기 어렵게 만듭니다. 오래되고 조잡한 주석은
insight-bgh.tistory.com
나쁜 코드에 주석을 달지 마라. 새로 짜라
- 브라이언 W. 커니핸. P.J. 플라우거 -
잘 달린 주석은 유용합니다. 하지만 근거 없는 주석은 코드를 이해하기 어렵게 만듭니다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미칩니다. 코드로 의도를 표현하지 못해서 주석을 사용하는 것은 실패를 의미합니다. 주석은 오래될수록 코드에서 멀어집니다. 프로그래머들이 주석을 유지하면서 유지보수하기란 현실적으로 불가능합니다. 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 주석이 필요없는 방향으로 에너지를 쏟는 것이 낫습니다. 함수나 변수로 표현할 수 있다면 주석을 달지 말아야합니다.
좋은 주석과 나쁜 주석을 구분하는 방법에 대해서 알아 보겠습니다.
1. 좋은 주석
[법적인 주석]
때로는 회사가 정립한 구조 표현에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시합니다. 예를 들어 각 소스 파일 첫머리에 주석으로 들어가는 저작권 저옵와 소유권 정보는 좋은 주석입니다. 모든 조항과 조건을 열거하는 대신에 가능하다면 표준 라이선스나 외부 문서를 참조해도 됩니다.
// Copyright (C) 2003,2004,2005 By Object Mentor, Inc. All rights reserved.
// GNU General Public License 버전 2이상을 따르는 조건으로배포한다.
[정보를 제공하는 주석]
기본적인 정보를 주석으로 제공하면 편리합니다. 다음 주석은 추상 메서드가 반환할 값을 설명합니다.
//테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();하지만 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어집니다.
[의미를 명료하게 밝히는 주석]
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워집니다.
[TODO 주석]
앞으로 할일을 //TODO 주석으로 남겨두면 편합니다. 프로그래머가 필요하다고 여기지만 당장 구현하기 어려운임무를 기술합니다. 더 이상 필요없는 기능을 삭제해달라는 부탁, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용합니다. 요즘 나오는 대다수 IDE는 TODO주석을 전부 찾아 보여주는 기능을 제공합니다. 그래도 TODO 주석으로 떡칠한 코드는 바람직하지 않습니다. 그러므로 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애는것을 권장합니다.
[중요성을 강조하는 주석]
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위햐서도 주석을 사용합니다.
2. 나쁜 주석
대다수의 주석이 이 범주에 속합니다. 대다수의 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화합니다. 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고하니까 마지못해 주석을 단다면 전적으로 시간낭비입니다.
[같은 이야기를 반복하는 주석]
같은 내용을 그대로 중복하는 주석은, 주석을 읽는 시간을 늘립니다. 또한 주석이 코드보다 더 많은 정보를 제공하지 못합니다.
[오해할 여지가 있는 주석]
주석을 보고 '살짝 잘못된 정보'로 인해 프로그래머가 오해를 할 수 있는 주석은 나쁜 주석입니다.
[의무적으로다는 주석]
모든 함수에 javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙을 어리석습니다. 예를 들어 모든 함수에 javadocs를 넣으라는 규칙이 낳은 괴물입니다. 아래와 같은 주석은 아무 가치도 없습니다.
/*
* @param title CD 제목
* @param author CD 저자
* @param tracks CD 트랙 숫자
* @param durationInMinutes CD 길이(단위 : 분)
*/
public void addCD(String title, String author, int tracks, int durationInMinuites){
CD cd = new CD();
cd.title = title;
cd.author = tracks;
cd.tracks = tracks;
cd.duration = durationInMinutes;
cdList.add(cd);
}
[이력을 기록하는 주석]
때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가합니다. 일종의 일지 혹은 로그가 됩니다. 예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했습니다. 당시에는 소스 코드 관리 시스템이 없었기 때문입니다. 하지만 이제는 혼란만 가중할 뿐이므로 완전히 제거하는 편이 좋습니다.
[있으나 마나한 주석]
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석입니다.
/*
* 기본 생성자
*/
protected AnnualDateRule(){
}
/* 월 중 일자 */
private int dayOfMonth;[위치를 표시하는 주석]
때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용합니다.
// ///////////////////ACTIONS///////////////////위와 같은 코드는 배너 아래 특정 기능을 모아놓으면 유용한 경우가 있기도합니다. 하지만 일반적으로 가독성을 낮추므로 제거해야 마땅합니다. 특히 뒷부분에 슬래시로 이어지는 잡음은 제거하는 편이 좋습니다. 그러므로 반드시 필요할 때만 아주 드물게 사용하는 편이 좋습니다.
[닫는 괄호에 다는 주석]
때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓습니다. 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐입니다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이든다면 대신에 함술을 줄이려시도합시다.
[공로를 들이거나 저자를 표시하는 주석]
소스코드 관리 시스템은 누가 언제 무엇을 했는지 알 수 있기 때문에 저자 이름으로 코드를 오염시킬 필요가 없습니다.
/* 릭이 추가함 */[주석으로 처리한 코드]
주석으로 처리한 코드만큼 밉살스러운 관행도 드믑니다. 다음과 같은 코드 작성은하면 안됩니다!
InputStreamResponse response = new InputStreamResponse();
response.setBody(formatter.getResultStream(), formatter.getByteCount())
//InputStream resultStream = formatter.getResultStream();
//StreamReader = reader = new StreamReader(resultStream);
//response.setContent(reader.read(formetter.getByteCount()));주석으로 처리된 코드는 다른 사람들이 지우기 주저합니다. 이유가 있어 남겨 놓았으리라고 생각을 합니다. 그렇기 때문에 쓸모 없는 코드가 점차 쌓입니다.
[HTML주석]
소스 코드에 HTML 주석은 혐오 그 자체입니다. 예를 들면 다음 아래와 같은 주석입니다.
/*
* 적합성 테스트를 수행하기 위한 작업
*
*<pre>
*용법 :
*<taskdef name="execute-fitnesse-tests"
*</pre>
*/[전역정보]
주석을 달아야 한다면 근처에 있는 코드만 기술합니다. 코드 일부에 주석을 달면서 시스템 전반적인 정보를 기술하면 안됩니다.
/**
* 적합성 테스트가 동작하는 포트 : 기본값은 <b>8082</b>.
*/
public void setFitnessePort(int fitnessePort){
this.fitnessePort = fitnessePort;
}함수 자체는 포트 기본값을 전혀 통제하지 못합니다. 즉, 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없습니다.
[너무 많은 정보]
주석에다가 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓으면 안됩니다. 딱 필요한 정보만 적어 둡니다.
[함수헤더]
짧은 함수는 긴 설명이 필요 없습니다. 짧고 한가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋습니다.
[비공개 코드에서 Javadocs]
공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없습니다. 시스템 내부에 속한 함수에 Javadocs를 생성할 필요가 없습니다.
클린 코드에서 좋은 주석과 나쁜 주석, 가독성 있게 형식을 맞추는 법에 대해서 알게 되어 정리하려고 합니다.
(제가 평소에 많이 쓰던 나쁜 버릇이나 중요하다고 생각드는 것 위주로 정리하겠습니다.)
바로 시작할게요~
주석
이 책의 저자인 밥 아저씨는 주석에 대해서 이렇게 말합니다.
주석은 기껏해야 필요악이다. 프로그래밍 언어 자체를 치밀하게 사용해 의도를 표현할 능력이 있다면 주석은 거의 필요하지 않다.
이렇게 주석을 무시하는 이유는 무엇일까요?
바로 주석은 오래되면 오래될수록 그릇될 가능성이 높아지기 때문입니다.
코드가 변화하고 진화할수록 조각이 나뉘어지고 합쳐지는데 여기서 주석까지 유지하고 보수하기는 현실적으로 불가능합니다.
이렇게 그릇된 주석은 프로그래머에게 거짓말을 하고 잘못된 정보를 전달하게 되는데
이것은 프로그래머의 시간과 에너지를 뺏기 때문입니다.
하지만 때에 따라 필요하거나 유익한 주석이 있고 정말로 사용하면 안되는 나쁜 주석이 있습니다.
지금부터는 좋은 주석과 나쁜 주석에 대해 소개하도록 하겠습니다.
좋은 주석 👍🏻
1. 법적인 주석
아래와 같이 저작권 정보나 소유권 정보는 소스 파일 첫 머리에 명시해야 합니다.
// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License
2. 정보나 의도를 설명하는 주석
추상 메서드의 반환값이나 정규표현식이 어떤 것을 뜻하는지의 정보를 전달하거나,
해당 코드의 결과값이나 중요성을 강조하는 주석이나,
프로그래머가 어떤 것을 의도했는지를 미리 명시해놓으면 타 프로그래머의 시간을 아껴줄 수 있습니다.
3. TODO 주석
아직 작성하지 못한 코드나 아직 구현하지 못한 코드를 미래에 작성해야 한다면 TODO 주석으로 앞으로 할 일을
설명해놓을 수 있습니다.
나쁜 주석 ❌
1. 같은 이야기를 하는 주석
아래와 같이 코드를 설명해주는 주석 대신 코드로 명확하게 표현해야 합니다.
(저도 평소에 이런식으로 많이 달아서 조금 찔리네요..)
//이름을 나타내는 변수
var name = "Fomagran"
2. 기록하는 주석
때때로 사람들은 어떤 사람이 언제 코드를 수정했는지를 적는 경우가 있습니다.
이런 것들은 소스 코드 관리 시스템에게 맡겨야합니다.
/*
*11-Oct-2021 클래스를 다시 정리하고 새로운 패키지인
com.jrefinery.date로 옮겼다.
*05-Nov-2021 getDescription() 메서드를 추가했으며
NotableDate class를 제거했다.
*/
3. 닫는 괄호에 쓰는 주석
많은 프로그래머들이 아래와 같이 닫는 괄호에 특수한 주석을 달아놓곤 합니다.
닫는 주석에 괄호를 다는 것 대신 코드를 분리하여 줄이려는 시도를 해야 합니다.
func add(n1:Int,n2:Int,infos:[Int]) {
for info in infos {
if n1 < n2{
while infos.isEmpty {
}//while
}//if
}//for
}형식
코드가 깔끔하고, 일관적이고, 꼼꼼하게 전문가가 짰다는 인상을 주기 위해선
코드 형식을 맞추기 위한 규칙을 정하고 그 규칙을 착실히 따라야 한다고 합니다.
이렇게 탄탄히 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미치게 되고
이것은 코드의 품질과 생산성을 향상시킵니다.
적절한 행 길이를 유지하라
위는 7개 프로젝트에 대한 파일 길이 분포를 나타낸 그림인데
평균 파일 길이는 약 65줄이며 대략 1/3이 40줄에서 100줄을 넘는 정도이다.
이것은 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실을 나타냅니다.
개념은 빈 행으로 구분하라
패키지 선언부,import문,각 함수 사이에 빈 행을 추가해서 새로운 개념이 시작한다는 단서를 남기도록 해야합니다.
나쁜 예 ❌
import Foundation
func getManhattanDistance(p1:Seat,p2:Seat) -> Int {
return abs(p1.0-p2.0) + abs(p1.1-p2.1)
}
func isKeepDistance(p1:Seat,p2:Seat,xMap:inout [[String]]) -> Bool {
let minX = p1.0 < p2.0 ? p1 : p2
let minY = p1.1 < p2.1 ? p1 : p2
if p1.0 == p2.0 {
return xMap[minY.1+1][p1.0] == "X"
}else if p1.1 == p2.1 {
return xMap[p1.1][minX.0+1] == "X"
}else{
if p1.0 < p2.0 {
return xMap[p1.1][p1.0+1] == "X" && xMap[p2.1][p2.0-1] == "X"
}else {
return xMap[p2.1][p2.0+1] == "X" && xMap[p1.1][p1.0-1] == "X"
}
}
}
좋은 예 👍🏻
import Foundation
func getManhattanDistance(p1:Seat,p2:Seat) -> Int {
return abs(p1.0-p2.0) + abs(p1.1-p2.1)
}
func isKeepDistance(p1:Seat,p2:Seat,xMap:inout [[String]]) -> Bool {
let minX = p1.0 < p2.0 ? p1 : p2
let minY = p1.1 < p2.1 ? p1 : p2
if p1.0 == p2.0 {
return xMap[minY.1+1][p1.0] == "X"
}else if p1.1 == p2.1 {
return xMap[p1.1][minX.0+1] == "X"
}else{
if p1.0 < p2.0 {
return xMap[p1.1][p1.0+1] == "X" && xMap[p2.1][p2.0-1] == "X"
}else {
return xMap[p2.1][p2.0+1] == "X" && xMap[p1.1][p1.0-1] == "X"
}
}
}
종속적이거나 유사한 코드는 가까이 두어라
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미합니다.
즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻입니다.
한 함수가 다른 함수를 호출 한다면 두 함수는 세로로 가까이 배치해야 합니다.
또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치합니다.
이렇게 일관적으로 적용하면 코드를 읽는 사람은 호출한 함수가 잠시 후에 정의되리라고 예측할 수 있습니다.
func solution(_ places:[[String]]) -> [Int] {
var answer:[Int] = []
for place in places {
...
getSeatLocation(places: place,xMap: &xMap,applicants: &applicants)
outer:while !applicants.isEmpty {
for applicant in applicants {
if getManhattanDistance(p1: first, p2: applicant) <= 2 {
if !isKeepDistance(p1: first, p2: applicant,xMap: &xMap) {
...
}
}
}
}
...
}
return answer
}
func getSeatLocation(places:[String],xMap:inout [[String]],applicants:inout [Seat]) {
...
}
func getManhattanDistance(p1:Seat,p2:Seat) -> Int {
...
}
func isKeepDistance(p1:Seat,p2:Seat,xMap:inout [[String]]) -> Bool {
...
}
종속적인 관계가 없더라도 명명법이 같거나 기본기능이 유사한 함수는 세로로 가까이 배치해야 합니다.
class Assert {
static func assertTrue(message:String,condition:Bool) {
}
static func assertTrue(condition:Bool) {
}
static func assertFalse(message:String,condition:Bool) {
}
static func assertFalse(condition:Bool) {
}
}
행 길이
한 행은 가로로 얼마나 적당해야 할까 또한 많이 고민했었던 것 중 하나인데요.
위 그래프는 큰 7개 프로젝트의 행 길이를 나타낸 것입니다.
20~60자가 40%이고 10자 미만은 30%이며 80자 이후부터는 급격히 감소합니다.
저자인 밥 아저씨는 100자에서 120자에 달해도 나쁘지 않으며 자신은 120자로 제한한다고 말합니다.
들여쓰기
소스 파일엔 클래스,메서드,블록 내에 적용되는 정보들이 있습니다.
이렇게 범위로 이루어진 계층을 표현하기 위해 들여쓰기 사용하는데요.
클래스 정의처럼 파일 수준인 문장은 들여쓰지 않고 클래스 내 메서드는 클래스보다 한 수준 들여씁니다.
메서드 코드는 메서드 선언보다 한 수준 들여쓰고 블록 코드는 블록을 포함하는 코드보다 한 수준 들여씁니다.
만약 들여쓰기가 없다면 코드는 아래와 같이 보일 것 입니다.
func solution(_ places:[[String]]) -> [Int] { var answer:[Int] = [] for place in
places { var check:Bool = false var applicants:[Seat] = [] var xMap:[[String]] = []
getSeatLocation(places: place,xMap: &xMap,applicants: &applicants) outer:while
!applicants.isEmpty { let first = applicants.removeFirst() for applicant in applicants
{ if getManhattanDistance(p1: first, p2: applicant) <= 2 { if !isKeepDistance(p1: first,
p2: applicant,xMap: &xMap) { answer.append(0) check = true break outer } } } } if !check
{ answer.append(1) } } return answer } func getSeatLocation(places:[String],
xMap:inout [[String]],applicants:inout [Seat]) { for (y,place) in places.enumerated() {
xMap.append(place.map{String($0)}) for (x,p) in place.map({String($0)}).enumerated() {
if p == "P" { applicants.append((x,y)) } } } } func getManhattanDistance(p1:Seat,p2:Seat
) -> Int { return abs(p1.0-p2.0) + abs(p1.1-p2.1) } func isKeepDistance(p1:Seat,p2:Seat,
xMap:inout [[String]]) -> Bool { let minX = p1.0 < p2.0 ? p1 : p2 let minY = p1.1 < p2.1
? p1 : p2 if p1.0 == p2.0 { return xMap[minY.1+1][p1.0] == "X" }else if p1.1 == p2.1 {
return xMap[p1.1][minX.0+1] == "X" }else { if p1.0 < p2.0 { return xMap[p1.1][p1.0+1] ==
"X" && xMap[p2.1][p2.0-1] == "X" }else { return xMap[p2.1][p2.0+1] == "X" && xMap[p1.1][
p1.0-1] == "X" } } }
가끔 간단한 if문,while문 등 짧은 함수에서 아래와 같이 들여쓰기를 무시하고 싶은 욕구가 생깁니다. (저 또한 많이 그랬음..)
하지만 이러한 사소한 것도 들여쓰기 범위로 제대로 표현해야 합니다.
나쁜 예 ❌
for i in 0...5 {
if i == 0 { continue }
}
좋은 예 👍🏻
for i in 0...5 {
if i == 0 {
continue
}
}'프로그램 개발(분석, 설계, 코딩, 배포) > 100. 기타' 카테고리의 다른 글
| 정보시스템 감리_정보시스템 감리 수행가이드 (1) | 2023.04.24 |
|---|---|
| VS Code 사용법 (0) | 2023.04.12 |
| 코드 기호 (0) | 2023.03.14 |
| java SE6(jdk1.6)을 상위버전으로 업그레이드 시 고민 사항 (0) | 2023.02.21 |
| SP 품질인증 모델 (0) | 2023.02.17 |
