[💬] 재미로 해보는 자기 코드가 이쁜지 보는 방법

[주사위열쇠(personal2282)]

얼마전에 누가 'private변수는 앞에 _붙이고 이런 명명 규칙같은게 있는걸 아무도 안알려줬다'라는 글보고

'일반적인 코딩스타일'이 어떤건지 궁금한 사람들을 위해 간단히 적는 글임

로켓 쏘는 NASA에는 유명한 '10대 코딩 규칙'(The Power of 10)이라는 게 있음.

'goto문 절대 쓰지 마라', '루프의 끝을 명확히 해라', '초기화 후에는 동적 메모리 할당하지 마라' 등등 엄청 깐깐함.

왜 깐깐하냐? 우주에서는 블루스크린 뜨면 재부팅하러 갈 우주비행사가 없으니까. 코드 줄 잘못 짠 버그 하나가 수조 원짜리 폭죽놀이로 이어짐.

> 재귀 호출 금지. 절대 안 됨.

> 모든 반복문은 증명 가능한 상한(최대 반복 횟수)이 있어야 한다.

> 초기화 이후에는 동적 메모리 할당 금지.

> 함수 하나당 최대 약 60줄.

> 함수마다 최소 2개의 assertion(검증 구문) 필수.

> 모든 반환값은 반드시 검사해야 한다.

> 컴파일러 경고는 0개여야 한다.

> 정적 분석을 매일 수행하며, 거기서도 경고 0개여야 한다.

> 함수 포인터 사용 금지.

> 포인터 역참조는 엄격히 제한된다.

우리가 NASA처럼 화성에 로봇을 보내는 건 아니지만

내 코드가 터지지 않을 이쁜 코드인지, 잠재적인 폭탄을 안고 있는지 실시간으로 검사하는 방법이 있음

보통 '정적 분석'이라고 불리는데 간단하게 보는 방법임

갤럼들 유니티 많이 쓰니까 유니티에 Visual Studio로 C# 코드 보는 방법을 기준으로 설명하겠음.

다른툴들도 정적분석 툴은 100%있으니까 제미나이나 채찍한테 물어보셈

보통 정적분석하면 툴을 갖다가 많이 쓰긴 하는데

오늘 할건 간단하게 원래도 나오던 경고를 최고수준으로 올리는거임

1. .editorconfig 파일 만들기

유니티 프로젝트의 최상단 (Assets 폴더랑 나란히 있는 위치)에 .editorconfig라는 이름으로 빈 텍스트 파일을 하나 만듦.

2. 분석 룰 몽땅 켜기

.editorconfig 파일을 열고 아래 내용을 복붙해서 저장함.

root = true

[*.cs]

# 모던 문법

dotnet_analyzer_diagnostic.category-Style.severity = warning

# 성능 최적화

dotnet_analyzer_diagnostic.category-Performance.severity = warning

# 잠재적 버그 및 설계 오류 규칙

dotnet_analyzer_diagnostic.category-Design.severity = warning

dotnet_analyzer_diagnostic.category-Reliability.severity = warning

3. Visual Studio에서 결과 확인하기

이제 VS에서 C# 스크립트를 열면, 백그라운드에서 분석기가 돌아가기 시작함.

물결선 경고: 구형 문법을, 성능 향상가능 코드에 초록색/노란색 밑줄이 그어짐

전구 아이콘 & 자동 수정: 밑줄 친 곳에 커서 두고 Ctrl + . 누르면, "이 코드는 이렇게 바꾸는 게 더 이쁨" 하면서 알아서 최신 문법으로 고쳐줌.

오류 목록(Error List) 창: 화면 하단 탭을 열어보면 내 프로젝트 전체에서 발견된 더러운 코드 리스트와 위반한 룰을 쭉 뽑아줌.

이렇게 세팅해두면 무거운 외부 툴을 따로 안 깔아도, 코드 칠 때마다 내 코드가 얼마나 이쁜지(혹은 더러운지) 실시간으로 지적당하면서 퀄리티를 올릴 수 있음.

근데 뭐 지적당한 부분들이 보통은 막 엄청 잘못된건 아님

예를들어 이건 그냥 줄일수 있다는거

성능뿐만아니라 가독성에 대해서도 지적이 들어옴

근데 지금 보니까 IDE0055가 많이뜨는데 이건 서식관련 경고라 나한텐 필요 없다 하는건 빼주면됨

아까 .editorconfig파일 밑에다가

dotnet_diagnostic.IDE0055.severity = none

이라는 라인 추가해주면됨

IDE0055대신 니가필요없는거 넣으면 제거가능

그러면 이런식으로 해당 코드번호의 경고는 전부 사라짐

VSCode는 이런느낌으로 비교적 직관적으로 나오는데 Visual Studio는 보기에 쪼끔 아쉽긴 하네

다들 쾌적하게 이쁜 코드 짜길 바람!

[엔록(whale0407)]

이거 전투기 버젼도 있더라 '예외처리 따위는 없다'같은

[익명(plastic4826)]

난 저거 다꺼버림 감히 인간의 코드에 노란경고를 띄우다니

[해당 댓글은 삭제되었습니다.]

해당 댓글은 삭제되었습니다.

[익명(182.226)]

재미로 보라는데 개뿔났노

[Indie 1(112.151)]

쒹 ... . 쒹 . .. .

[익명(218.144)]

@ㅇㅇ(182.226) 에디켜고 적용하는법까지 상세히 적길래 재미로 하는거같진 않아보이는데.. 걍 웃겨서

[Indie 2(14.32)]

어휴 이런 인베디드나 먹힐만한 논리를 가지고 오는거 자체가 아마추어라는거 게임 엔진이 보편화되고 메니지드 코드가 기본으로 자리잡은 지금 어디서 굴러먹다오던 C 스타일을 무슨 기술이랍시고 내 놓는지

[Indie 3(103.108)]

나도 이 얘기 할까하다가 괜히 일침 놓는거같아서 안했는데 시원하노 ㅋ

[익명(59.13)]

이 글의 어디가 자꾸 애들 발작버튼 누르는거냐ㅋㅋ 글쓴이가 뭘 강요한것도 아니고 궁금해 하는애 있길래 썼다는데

[익명(218.155)]

@ㅇㅇ(59.13) 원론적으로 문제안터지는 코드가 좋은것도 맞는데 걍 이럴수있다 글보고 개발작하는애들은 왜그러나싶네

[Indie 4(58.231)]

니 코드가 잘못됏다고 하는것도 아니고 이런것도 잇다인데 ㄹㅇ 왜 발작하는거임

[익명(218.144)]

혈액형 성격 얘기하는데 갑자기 끼어들어서 열변 토하는 느낌

[Indie 5(121.169)]

근데 결론적으로 글쓴이가 소개한 editorconfig는 협업에서 특히 유용한던데…