#region으로 Code folding 하기

[9H05T]

The Problem With Code Folding

최근에 협업을 하다가 code folding에 대해서 다시한번 생각하게 되었는데요.
여러분의 생각은 어떠신지요?

위의 블로그 내용을 보면 #region으로 묶고 folding 하는 것은 해악이다! 라고 주장하고 있습니다.
협업 시, 코드를 알아보기 힘들고 대부분 안좋은 코드가 적혀있다! 라는 주장입니다.

또 댓글들을 쭉 보면 반반, 반대, 찬성 등 여러가지 의견이 갈리네요.

저는 code가 folding 되어 있는거 자체를 별로 좋아하지 않습니다.
즉각적으로 읽을 수가 없거든요. 물론 docs comment나 좀 긴 comment 라면 괜찮습니다.

하지만, 코드 자체가 folding 되어 있다면 신경이 굉장히 거슬리네요.
클릭을 한번 더하거나 단축키를 한번 더눌러야 하는 번거러움도 있으니까요.

여러분들의 생각을 어떠신가요?

[김청호]

저는 정말 말 그대로 region을 구분해야 할 때랑, 코드가 긴데 더 이상 들여다 볼 일이 없는 코드를 접어 놓는 용도로 쓰고 있습니다. 실제로 유용해서 굳이 해악으로 분류해야 하는지는 잘 모르겠네요.

[9H05T]

ㅎㅎ 포스팅 내용을 보시면 아시겠지만 의견이 분분합니다.
저도 해악까지는 아니라고 생각하거든요. 약간 거슬릴뿐…
folding에 대해선 별로 생각이 없었는데 포스팅 내용을 보니 한국 개발자분들의 의견이 궁금해졌습니다 ㅋㅋ

[Vincent]

저는 IT는 100% / 무조건 이라는 것은 없다고 생각해서, 그냥 기능을 지원해주는 만큼 그냥 쓸 꺼 쓰고 그러면 되는 거 같습니다.

저도 region은 적절하게 쓰는 편입니다.

[루나시아]

협업을 해본 적이 없어서 region을 이용한 코멘트가 도움이 되느냐 하는 것에 대해 확신할 수는 없지만, 결국 이 역시 개인의 주관 및 사용하기 나름 아닐까 싶네요.

단순히 펼치는 게 번거롭다는 것이 접지 말아야 할 사유가 될 수 없고, 접으면 코드 라인이 줄어든다는 것도 접어야 할 사유가 될 수는 없을 것 같아요.

코드 종류에 따라 기능별, 혹은 유형별(프로퍼티인지, 필드인지, 메서드인지 등)로 명확하게 구분지어 접고 코멘트로 확실하게 명시한다면 도움이 될 수 있는 요소라고 볼 수 있을 것이고, 중구난방으로 접고 코멘트도 대충 적어서 읽는 사람이 region을 어떻게 분류한 건지 이해할 수 없다면 잘못 사용하고 있는 것이겠지유. 팀이라면 컨벤션도 고려 사항이구요.

저는 개인적으로 MVVM 패턴 하에 있는 뷰모델의 경우 프로퍼티와 생성자, 커맨드 같이 정형화 된 것들은 유형별로 묶어 접어두는 편이고, 비즈니스 로직의 경우 상세 단위별로 묶을 수 있으면 묶어서 접어두는 편입니다.

반면 코드가 짧으면 굳이 접을 필요가 없고, 접어야 할 정도로 코드가 길다면 객체 설계를 잘못한 것이다 라고 생각하는 분들도 있을 것 같아요.

결국 명확하게 가독성에 해가 되지 않는 선에서, 또 컨벤션이 있으면 컨벤션 하에서 취향따라 적절하게 선택해야 할 기능이라고 봅니다.

[CODE_REAPER]

안그래도 최근에는 region 블록을 활용하기 보다는, 파일을 최대한 쪼개는 방식으로 시도해보고 있습니다.
원래는 region을 많이 쓰는 스타일이었는데요. 최근 들어서 제 코드를 보다보면, region으로 묶을 생각하고
그 안에다가 대충 때려박는(?) 제 모습이 보이더군요…
그럴 바에는 소스 파일을 쪼개서, 용도나 기능에 맞게 분리하는게 더 낫겠다…라는 생각을 하고 있던 참이었습니다.

근데 저 링크의 글쓴이처럼 뭐가 최악의 코딩 스타일이다 이런건 없는 것 같아요…
자기 눈에 편한 그런 스타일이 있는거겠죠^^;
예를 들어 간단한 if 문을 쓰더라도
if(obj == null) { return; }
저는 이런 식으로 중괄호를 다 붙이는 편인데, 다른 사람 눈에는 되게 거슬리는 스타일이 될 수가 있듯이요…^^;;

[9H05T]

의견 주신분들에 따르면, #region과 객체지향 설계의 상관관계가 있을 수 있겠네요.
재밌는 주제인건 확실한 것 같습니다.

기회가 된다면 #region와 객체지향 설계를 자세하게 비교 해보는 것도 좋을 것 같네요.

간단하게 비교 해볼까요?
일단 블로그에 따르면

이런 형식의 코드는 굉장히 좋지 않다는 의견이고
확실히 이런 #region code folding이라면 SRP를 위반하는 경우도 있을 것 같습니다.

어찌보면 이런 형태가 더 좋을 수도 있다고 생각이 들기도 하네요.

하지만 하나의 함수가 여러개의 portion으로 나뉜다면 #region은 오히려 더 좋은 가독성을 갖출 것 같습니다.

여기서 inner_logic이 SRP를 위반하지 않는다는 가정을 한다면 가독성 측면에서 훨씬 좋을 것 같습니다.
다만 inner_logic이 정말로 function 단위로 쪼갤수 없는 atom 형태인가?에 대해서는 고민이 많을 것 같네요.

[마수리]

음… 저는 region을 사용하는 것을 그닥 선호하진 않습니다

region 쓰기보다 파일을 나누던가 함수로 나누는게 좋아보이긴 합니다.

예를들어

#region 윈도우 다시 시작 함수
private void Func1();
private void Func2();
#endregion

#region 파일 검증
private bool Func3();
private bool Func4();
#endregion

이런편이라면 개인적으론 파일을 나누는게 좋아보입니다.
그것이 더욱 더 SRP에 맞는 코드가 될 것 같습니다.
만약 저런 코드를 계속 두면 깨진 창문 법칙에 의해 클래스는 점점 더 여러가지 기능을 갖게 비대해 질 것 같습니다.
만약 이 클래스의 이름이 엄청 일반적이면 더욱 더 그러할 확률이 높습니다.

개인적으로 region을 사용하기에 괜찮겠다라고 생각했던 부분은

MVVM 패턴을 사용하려면 필연적으로 view와 viewmodel을 이어주는 레이어 겸의 property들이 많아지는데
사실 이 property들은 로직이 아니라 읽지 않는 경향이 있습니다 ㅎㅎ 그래서 이럴 땐 region을 사용하는게 좋아보이기도 했습니다.

[dimohy]

#region의 기능적인 측면을 생각해보면 마치 우리가 자주 쓸 일이 없는 물건을 상자에 담아 창고에 넣어 두는 것 같은 느낌을 받습니다.

개인적으로는 #region을 지양하는 편인데요, 이유는 가시성이 좋지 않기 때문입니다. 감춰져 있으면 필요할 때 찾기가 너무 힘들지 않나요?

차라리 워크플로우 수준의 코드를 파일의 상단에, 세부 코드를 파일의 하단에 배치하거나 또는 partial로 이 두 구조를 분리하거나

아니면 좀 더 구조화 해서 쪼개거나 – 하지만 너무 깊은 구조화는 코드 가독성을 해친다는 주의이기도 합니다 – 하는것을 선호하는 편입니다.

[Greg.Lee]

대체로 region 사용에 부정적인 글들이 많군요.

근데 resharper 를 사용한다면 얘기가 달라진답니다…

resharper 의 FileStructure 를 이용하면 region 으로 묶은 것들이 그룹으로 표시되어 나타납니다.

소스코드에서 정리가 잘 되어 있어도 ‘여기서부터 여기까지는 요것들 묶음’ 이라는 의미로 사용할 수 있지요.

그리고 이게 실제로 꽤 편리하기도 하구욜. ㅇㅅㅇ/

resharper 를 사용한다면 ~
region 은 적절하게 잘 그룹으로 묶어 사용하기 좋은 기능이라고 저는 생각해서 추천!

[level120]

code snippet 형태로 사용하는 분들은 보고 난 뒤 저는 region을 그리 좋아하지 않게 됐어요…

@@기능이 필요한데? 라고 했을 때 “어 그 %% 파일에 $$ region 복사해서 쓰면 돼” 이런 경우도 있었거든요.
사실 편하기야 편하겠지만 저는 다른 의미로 생산성을 떨어뜨리는 것(가독성이라던가 한 클래스 내 역할 분할 등) 같아서 더 그런 것 같아요.

stylecop과 같은 분석기를 사용하면 SA1201과 같이 클래스 내 아이템 순서를 강제하게 되는데 여기에 적응하고나서 region이 가득한 코드를 보게되면 클래스 뷰어? 같은 도구가 없는 한 함수며 이벤트 등을 바로 못 찾아가겠더군요.

만약 한 클래스 내 함수가 너무 많고 이를 분할하고 싶다 - 그러면 region을 사용하는 것이 더 보기좋을 수 있지만 전 이런 상황이 생긴다면 아마도 partial 키워드를 넣고 Some.Behavior.cs와 같이 파일을 나눌 것 같아요.