[💬] Readability 의 문제

[익명(59.13)]

대부분 관심도 없는 goto 떡밥 글 하나 더 올리는 것 같지만 더 하고싶은 이야기가 있어서 써봄.

결론부터 말하자면,

goto 문을 쓰지 말아야할 가장 큰 이유는 가독성(Readability) 문제이다.

프로그래밍할때 우리는 쓰기편한 코드보다 가독성 높은 코드를 생산해야한다.

코드를 작성할 때의 내 머릿 속에는 그에 관련된 정보들로 가득하지만 한숨 자고나면 다 잊혀지게 마련.

수정하려면 머릿속에 이전에 작성하던 정보를 재구성해야하는 과정이 필요하다.

프로그래밍 과정에 쓰이는 시간이나 에너지를 비교해보면

코드 그 자체를 쓰는 시간보다, 이렇게 이미 써놓은 코드를 머릿속에 다시 이해시키는 시간이 오래 걸리는 경우가 대부분임.

가독성이 낮은 코드일 수록 더욱 그러한데, 흔히 말하는 스파게티 코드를 생각해보면 이해하기 어렵지 않을 거다.

이건 혼자 개발하든 같이 개발하든 똑같은 문제.

혼자 개발하더라도 나는 내가 만든 코드의 독자라는 점일 생각해야함.

코드를 다시 보더라도 이해하는데 시간이 적게 걸릴수록 우리 생산성은 높아질 것이고 버그도 줄어들 것이고 출시날짜를 하루라도 당길 수 있을거다.

goto 문은 그런 의미에서 쓰기에 매우 직관적이지만 읽기에는 매우 난해하다.

두군데 이상쓰이게되면 코드가 금방 암호문으로 바뀌게 된다.

남이 읽기에도, 내가 읽기에도 힘들게 되는거다.

그리고 대부분의경우 goto를 대체할 언어의 문법적인 지원이나 테크닉이 있으니

이런 쓰기편한 코드의 달콤한 유혹을 멀리하고 프로그래밍 테크닉을 좀 더 익혀 Readability를 높여보도록 하자.

아래는 가독성 높은 코드를 만들기 위한 몇가지 팁.

1. var 의 모호성[C#]

var f = GetMagicNumber();

var total = 100 * f / 6;

Console .WriteLine( $"Declared Type: {total.GetType().Name} , Value: {total} " );

위와 같은 코드가 있을 때 GetMagicNumber 값에 따라 아래와 같이 결과가 달라 질 수 있다.

var를 명확한 타입으로 바꾼다면 이해하기 쉽고 버그를 막을 수 있는 코드를 만들 수 있다.

Declared Type: Double, Value: 166.666666666667

Declared Type: Single, Value: 166.6667

Declared Type: Decimal, Value: 166.66666666666666666666666667

Declared Type: Int32, Value: 166

Declared Type: Int64, Value: 166

2. var 의 적절한 사용[C#]

var newData = currentData;

newData += addFor;

return newData;

위와같이 지역변수로 사용되며 새로운 타입을 굳이 알 필요가 없을 때는 var를 사용하는 것이 가독성이 높을 수 있다.

3. 과도하거나 너무 뻔한 주석

// 빗자루를 고양이로 만듬

var temp = Magic(data);

return temp;

라는 코드를 아래와 같이 바꾸면 주석 없이도 쉽게 읽히게 된다.

var makeBroomIntoCat = Magic(data);

return makeBroomIntoCat;

4. 비교문

if (data == 10) return true;

위의 코드는 자칫하면

if (data = 10) return true;

라는 코드로 잘못 타이핑되어서 컴파일러에도 잡히지 않는 버그를 유발할 수 있다.

이를 잘 읽히고 문제없는 코드로 만들기 위해서는

if (10 == data) return true;

이렇게 바꿔줬을때 위의 실수를 방지할 수 있다.

그 외에도 Code conventions 등 가독성을 높이기위한 여러 방법 들이 있다.

다만 가독성이란 어느정도 주관적일 수 있으므로 스스로 혹은 팀원과 규칙을 만들어 보는것도 좋겠다.

[익명(122.43)]

가독성 세글자로 요약할 수 있는걸 주절주절 적은거 보면 너부터 실천해야됨 ㄹㅇ

[익명(59.13)]

가독성이란 말이 어떻게 실천해야할지 모호할 수 있어서 풀어써봤음 인붕이들 좀 도움이 됐으면 해서 썼는데 별루인감..?

[ㅁ(1.231)]

ㅋㅋ 이런색히는 거르셈

[asdasd(59.15)]

개인적으론 과도하거나 뻔한 주석이여도 팀작업이라면 무조건 해주는게 좋다고 봄.

[dwqr(61.81)]

Declared type보단 Deduced Type이 맞을듯

[익명(59.13)]

effective c# 책에 나오는 예제임ㅎ;

[익명(59.13)]

그리고 애초에 추론이 아니라 형 자체를 출력하는거니깐 declared가 맞지

[익명(223.62)]

여기에 그거 모르고 goto얘기하는놈 하나도없을듯 애초에 쓰는경우 얘기할때 단점이 있고 항상쓰는게 아니라 특수한 경우 이득이 손해나 위험보다 높은 극단지점이 있다 이렇게 말을하는데 왜 이악물고 기초강의들을 하는거야?

[익명(59.13)]

goto 만의 얘기가 아니라 코드 가독성에 관한 이야기인데 난독증있니? 아니면 내 글이 정말 가독성이 부족한가봐..

[익명(223.62)]

그래 그 코드 가독성이 단점에 속해있단 생각은 안드니? 독해력을 키우다 사고력을 잃었니?

[59.13(110.70)]

코드가독성이 단점에 속해있다니 니가하는말은 당최 한글인지 중국어인지 외계어인지 모르겠다. 코드 가독성을 중요하게 생각안할수는 있지만 가독성을 높이는게 단점이라는게 말이 된다고 생각하냐? 나열한 예시 들은 언급한것처럼 주관적으로 동의 안할수 있겠다만. 니 말대로라면 가독성이 높아서 안좋은 상황이 있다는건데 이게 말인지 방구인지 정말ㅋㅋㅋㅋ

[59.13(110.70)]

특수한 경우 이득이 손해나 위험보다 극단지점이 있다 이게 대체 무슨문장인지 진짜ㅋㅋㅋ 국어시간에 뭐했는지 모르겠는데 문장력좀 키우고 살아라 저번글에서도 그렇고 니댓글보면 하나같이 뭔말인지 한참들여다보게된다

[59.13(110.70)]

애초에 쓰는경우 얘기할때 단점이 있고 항상쓰는게 아니랔ㅋㅋㅋㅋㅋ 아오

[이 댓글은 게시물 작성자가 삭제하였습니다.]

이 댓글은 게시물 작성자가 삭제하였습니다.

[59.13(110.70)]

마지막으로 이상한 논리로 어거지 좀 부리지마 망한 틀딱언어들이 왜 망하는지 이유도 쫌 제대로 찾아보고

[이 댓글은 게시물 작성자가 삭제하였습니다.]

이 댓글은 게시물 작성자가 삭제하였습니다.