ukk1211
556
2019-08-10 15:25:24
11
1297

주석 안달아 놓는 이유가 뭔가요?


클라이언트 프로그램 개발하여 고객사에 납품하는 부서고 인원이 적어 저 포함 3명 입니다 팀장 선임급 저(사원급) 한달 전쯤 경력으로 입사해서 공부하고 소스코드 보는데 주석이 거의 0입니다 소스코드는 꽤 길긴한데 선임급이 혼자 다 만들었다는데요 (사실인지는 모르겠습니다)제가 왜 소스 주석이 없냐니까 개인취향이고 소스 주석 달아놓으면 나중에 주석 위주로만 봐서 소스코드 유지보수시 불편하다 뭐다 이러더라고요. 제가 삐딱? 한걸 수도 있는데 왠지 자기 밥그릇 뺏기기 싫어서 일부러 안달아 놓은거라는 생각이 자꾸 듭니다 자기애가 매우 강하시고 프라이드가 있어서 일부러 보기 어렵게 한거 같기도 하구요 ㅠㅠ 소스코드가 짧은게 아니라 어렵구요 이런 경우가 흔한가요? 어떻게 해결해야 되나요ㅠ

0
0
  • 댓글 11

  • John Suhr
    1k
    2019-08-10 15:29:02

    메서드명을 잘 지어서 self explain이 된다면 주석이 없어도 되겠지만 a() 이런식으로 메서드 만들어서 주석이 없으면 흐음...

    3
  • LichKing
    14k
    2019-08-10 15:29:30

    흔하죠

    3
  • ukk1211
    556
    2019-08-10 15:30:12

    John Suhr 메서드 이름은 나름 해석되게 지어놨습니다

    3
  • defult
    2k
    2019-08-10 15:32:26

    아래 같은 경우는 그냥 그 사람이 이상하다고 보면 됩니다.

    •사내 코드 규약조차 없는 환경이다

    •함수, 변수명에 의미전달이 확실하게 전해질지 여부는 생각안하고 축약한 단어 난발하고있다

    •주석 필요없다면서 함수에 처리 내용 개요조차 안적고있다

    2
  • 플라이투
    140
    2019-08-10 15:36:01

    일관성있는 구조 & 심플하고 간략하게 코딩해서 읽어도 이해가 갈수있게 짜져있다면 주석은 굳이 없어도 된다고 생각합니다.

    관리안되는 너무 많은 주석은 혼란을 가져오죠. 특히 코드와 주석이 맞지 않을때...

    3
  • satis
    2k
    2019-08-10 15:42:38

    주석, commit 코멘트 없는거 답없죠...

    이미 습관이라면 바꾸지 못합니다.

    이를 해결하기위해 형상관리 솔루션에서 commit 코멘트 형식을 주어 강제로 작성하게 (작성규약에 안맞으면 commit불가) 합니다.

    3
  • ggugers
    2019-08-10 18:54:02

    혼자 다 만드는 문화면 주석 안달린 소스 꽤 있죠. 주석 없는 소스 분석하는것도 능력이겠죠.

    2
  • 스텁
    1k
    2019-08-10 19:39:38

    그 유명한 클린코드에서는 코멘트 비추천하지않나요? 그전에 코드를 클린하게 짜라는게 전제이긴 하지만요. 

    주석은 어글리코드를 설명하기 위한 군더더기이다? 이런정도로 미디엄이나 에서 본거 같네요.

    2
  • 방가방가2
    1k
    2019-08-10 20:04:59

    1. 너무 바빠서 주석을 쓸 시간 조차 없어서

    2. 자꾸 설계사양이 변경이 되어서, 임시로 만들어둔게 굳어지는 경우


    3
  • 크로스핏
    49
    2019-08-11 00:15:50
    주석이 필요하면 애초에 네이밍이 잘못됐거나 설계가 문제가 있다고 생각합니다
    0
  • ignoreOrange
    1k
    2019-08-12 09:21:09

    주석은 없을수록 좋은 코드이긴 합니다.

    0
  • 로그인을 하시면 댓글을 등록할 수 있습니다.