lIlIlIlIlI123
15
2019-10-09 19:02:29 작성 2019-10-09 19:02:49 수정됨
61
3745

주석 다는건 당연히 해야하는거 아닌가요??


읽기좋은 코드라고한들

그건 주관적이고 읽는데 개인차가 있는건데

업데이트는 100회 가까이하고 코드가 년단위로 쌓인 프로젝트에

주석이 단 한줄도 없어요.


만든사람은 퇴사했고 회사에 이 프로젝트 아는 사람도 없고 황당..

0
1
  • 댓글 61

  • 초보1인개발자
    69
    2019-10-09 19:14:47

    자기도 만든 프로그램 까먹을까봐 주석다는데 도대체 어떻게 만든거죠 ㄷ

    4
  • 동대
    996
    2019-10-09 19:21:49
    현재 코드랑 최근 커밋내역순으로 분석하는수밖에 없지요...
    3
  • 방가방가2
    1k
    2019-10-09 19:31:12

    위에서 빨리 만들라고 갈굼 -> 허겁지겁 -> 주석없음 -> 쓰레기 코드 인수인계 받았다고 궁시렁 -> 역사의 반복

    10
  • baltasar
    6k
    2019-10-09 20:06:38 작성 2019-10-09 20:56:52 수정됨

    주석을 달아야 한다는 법은 상법이나 민법 몇 항에 있습니까?

    산출물은 전임 개발자의 소유가 아닌 회사의 소유이므로, 업무분석은 전임 개발자가 아닌 회사에서 근로자에게 해줘야 합니다.

    회사가 성의있는 주석을 받고 싶다면 개발자를 대우를 잘 해주고 월급을 더 줘서 구슬리든지 해서 얻어내면 됩니다.

    그리고 해당 산출물 중에 특별히 라이선스나 범용적인 라이브러리를 제외한 모든 코드는 회사의 소유가 옳습니다만, 산출물을 만들어내는 지식이 전부 회사의 것은 아니라 개발자의 소유도 있습니다. 그러므로 그 업무지식을 얻고 싶다면 주석에서 찾지 마시고 회사에 부탁하여, 회사가 전임 개발자에게 기술지원, 개발노하우 강의료를 지불하고 강의를 받은 후에 글쓴이에게 알려주는 것이 옳은 방법입니다.


    글쓴이도 거저 얻으려고만 하지 마시고, 힘들게 코드와 업무를 분석해서 자기 것으로 만들고 누구에게도 절대 알려주지 말고 잘 쥐고 있은 후에, 근로자에게 기술 및 업무 제반을 제공하지 않은 회사와 다음 연봉협상을 할 때 다 보상받으시기 바랍니다. 이런 걸로 연봉협상에서 연봉 올려야지, 절대 회사가 연봉 그냥 안 올려줍니다.


    저는 javastudy, javanuri, javaservice의 운영진들이 사이트를 전부 폐쇄시킨 것을 정말 잘했다고 생각합니다.

    -3
  • 방가방가2
    1k
    2019-10-09 20:31:49

    http://m.hanbit.co.kr/store/books/book_view.html?p_code=E2375873090

    ----

    개발자로 평생 먹고 살수 있다. 

    프로그래머들은 언제나 남들이 코드를 쉽게 이해할 수 있도록 작성하기 위해 노력한다. 하지만 남들이 쉽게 이해할 수 있는 코드만 작성한다면 자신의 가치를 높일 수 있을까? 제대로 기능은 수행하는데, 남들이 코드를 이해하기 어렵다면? 아마도 주변 사람들은 관련 프로그램을 유지보수하기 위해서 당신만을 찾게 될 것 이다. 노하우를 숨길 수 없을까? 이 책의 저자인 로에디 그린은 이런 의문을 시작으로 유지보수하기 어렵게 작성하는 방법들에 대해서 고민하였다. 저자가 제시하는 방법들을 하나하나 따라 하다 보면, 자신의 가치를 높일 수 있는 코딩 방법을 배울 수 있을 것이다.

    ------

    @baltasar 님에 맞는 도서입니다.

    12
  • defult
    2k
    2019-10-09 20:33:33 작성 2019-10-09 20:36:04 수정됨

    회사 코딩 규약에 제대로 명시하고, 제대로 갱신할 여유가 있어야 달리는게 주석입니다.

    주석은 어디까지나 다음에 만질사람이 편하게 하는것이고 코드에대한 권한은 회사에 있고 해당 내용을 어찌할지는 회사가 관리하는것이기에 관리를위한 코딩 규약을 제대로 명시할 책임은 회사에 있는것이며 규약조차 없고 개발일정 촉박에 매번 요구명세가 바뀌면 없는게 기본이죠.

    그리고 당연히 개발자는 개발룰에 없으면 안그래도 촉박한 일정을 더 쪼개가면서 그런 편의까지 봐줘야할 이유가 없고요


    4
  • 타키투스
    867
    2019-10-09 20:55:47

    ㅋㅋㅋ 또또... 사회탓, 회사탓 시전 나오네요...

    규약이고 나발이고.. 개발자라면 주석다는건 당연한 겁니다. 다음에 만들사람을 편하게 하는.. 같은 개발자로서 개발자를 챙기는 일인데도,, 회사의 제도, 규약 운운하는 것보다 차라리 일정 빡빡해서 주석 못단다고 하소연하는게 더 있어 보입니다.

    회사가 코딩 규약을 정의하지 않아도 이미 많은 프로그래밍 언어들이 자체적인 규약을 가지고 있는 경우가 많은데, 그것마져 회사가 정해주지 않아 나 몰라라... 결국 그건 지금 글쓴이처럼 또 다른 개발자들을 힘들게 하는 것 아니겠어요. 개발자가 개발자를 고통에 몰아넣는 광경... 개발룰에 없으니 주석 안달아도 된다.. ㅋㅋ 멋진 마인드네..

    4
  • baltasar
    6k
    2019-10-09 20:57:40 작성 2019-10-09 21:00:28 수정됨

    //타키투스

    프로그램에 주석을 달아야 한다는 법은 상법이나 민법 몇 항에 있습니까?


    그리고 주석 안 달려 있으면 회사가 시간을 좀 여유롭게 줘서 하나 하나 천천히 해독해가면 되는 겁니다. 새로 온 개발자에게 해독시간을 촉박하게 준 회사가 잘못입니다.

    산출물은 회사의 소유이고, 그 산출물로 돈을 버는 것도 회사입니다. 회사가 잘못한 걸 전임 개발자에게 덮어씌우시네요.

    1
  • defult
    2k
    2019-10-09 21:07:03 작성 2019-10-09 21:08:09 수정됨

    타키투스 님//

    애초에 코드만으로 가독성 좋게 하는것도 좋은 개발 방식으로 퍼지고 있고 단순 개요만이라도 IDE 프로그램에서 참조대상에 마우스 가져갔을때 나오는 개요 명시 레벨은 적어주는 등 주석에 대한 중요성은 개발자 마다 다 다릅니다.

    그런상황인데 주석을 달아야 하는게 당연하다고 할수는 없죠.


    그래서 당연히 회사는 관리를 위해서 개발 규약을 둬서 중구난방인 개발 및 관리방식을 자신에 맞춰서 이루어지게 해야하는겁니다.

    그리고 주석 달아놔서 납기 얼마안남아서 내용 갈아치우게 만들어놓고 그 주석들 갱신할 타임도 안주게되면 그경우 주석은 밀어버리는게 오히려 가독성 오릅니다.

    관리 책임자가 할일을 안해서 생기는 문제를 고용된 개발자에게 전부 돌리는건 안되죠

    1
  • 즈루시
    12k
    2019-10-09 22:00:05

    관리가 잘되는 주석이라면 언제나 환영...

    7
  • baltasar
    6k
    2019-10-09 22:24:25 작성 2019-10-09 22:46:07 수정됨

    이건 좀 다른 이야기인데,

    뭐가 됐든 외주받은 시스템은 결국엔 원청이 자회사 명목으로 만든 회사에게 빼앗기게 돼 있습니다.

    안정화된 운영사업권을 놓고 기존 운영사 VS 다른 법인 다수가 피 튀기게 전쟁하는 건 이미 20년도 더 된 민속적인(?) 일이죠.

    심지어는 원청소속 운영PM이 법인 설립해서 해당 시스템 운영사업을 집어먹는 경우도 있는데, 이런 경우 실질적으로는 해당 대기업의 자회사인데 대기업이 먹을 수 없으니, 원청 정규직을 바지로 내세워 무연고 법인을 만들어서 운영사업을 먹는거죠.

    파리바게트의 위장파견문제는 파견업체들이 죄다 파리바게트 임원이 설립한 업체이라 적발됐을 뿐입니다.

    쉽게 만들고 주석을 잘 달아놓으면 회사에서는 득을 볼 거라고 많은 개발자들이 알겠지만 절대 그렇지 않습니다. 시스템이 안정화되면 안정화 될 수록 더 빨리 운영사업을 빼앗기고 그만큼 빨리 망합니다. 시스템 안정화 안돼서 개판이고 헬게이트 열려서 전부 막차 타고 퇴근하고, 새벽에도 남아서 일한다고 소문이 나야 다음 운영사업 입찰에 똥파리들이 안 들어옵니다. 운영사업 오래 유지하거나 오히려 커지는 회사는 해당 대기업이나 금융사 이사,부장 출신들이 설립해서 만든 회사들 뿐입니다. 운영사업 뿐 아니라 시덥지 않은 콜센터 인바운드마저도 안정화되면 결국에는 얘네들이 다 먹습니다. 인맥영업과 자금세탁, 캐쉬백 영업을 하니까요.

    대표적으로 미**즈(주), 바**스(주), (주)블**임 등이 있습니다.


    결론은 두 가지입니다.

    1) 프로그래머들이 주석 열심히 달고 시스템 많이 개발하며 일한다고 외주받는 시스템 개발 회사는 득 보는 거 없다. 오히려 더 빨리 망한다.

    2) 기술있는 무연고 개발회사가 외주로 개발해서 운영한 사업은 오래 가야 최대 5년이면 정말 많이 먹은거다. 너무 말끔하게 잘 만들어 놓으면 운영 시작 1년 후에 다 빼앗긴다.

    3) 그러니까 외주는 프로그래머든 회사든 답 없다.(물론 다 망해도 사장 혼자는 돈 벌어갈 가능성 99.9) 자체 시스템 개발해서 서비스하는 회사 가라.


    개발자들이 자기 회사를 사랑한다면 시스템을 더 어렵게 만들어서 아무도 손 못대게, 다른 회사가 못 들어오게 방어하세요.

    2
  • setoka
    549
    2019-10-09 22:31:18

    당연한건 없죠

    주석 없어서 이해하기 힘들어지면 그냥 작업시간이 더 걸리는거고, 

    그 작업시간은 그냥 회사가 부담해야하는거죠


    개발자가 개발자를 고통에 빠트린다는 말이 좀 웃기네요

    해독하기 어려우면 시간 더 걸리고, 시간이 더 걸리면 그만큼 돈 더 받아가야죠

    그만큼 시간과 돈을 지불할 책임은 회사에게 있는거고요

    그걸 전임자 욕하면서 쌩고생해서 억지로 날짜 맞춰주면......, 보통 그런걸 공동체를 파괴하는 행위라고 그러죠

    2
  • tco99
    1k
    2019-10-09 22:40:33

    지금 하는 프로젝트는 최대한 주석 없이, 보기 쉽게 만드는게 프로젝트 룰 입니다. 찾아보니까 API 리스트에만 주석이 조금 있네요. ㅋㅋ


    2
  • StringBuilder덕후
    391
    2019-10-09 23:49:39
    시간 지나서 업무가 급하게 수정하고 추가해서 주석과 코드내용이 달라지면 오히려 없는것 보다 못합니다
    2
  • 타키투스
    867
    2019-10-09 23:56:54

     baltasar 


    개발일정이 빡빡한 상황은 알겠는데, 그러면 주석을 다는 시간을 어느정도 줄지 정량화 가능한가요? 빡빡하면 빡빡한 대로 어짜피 코딩하면서 대충 한줄이라도 달아 놓을 수 있는거죠. 


    주석이 없어서 이해하기 힘들어지면 비용 부담을 회사가 해야 한다는 건 억지일 수도 있죠. 일정이 빡빡한데, 주석 못단다고 하면 그러면 주석다는 시간을 정량화할 수 있나요? 그때가면 또 어떤 주석을 어떻게 몇줄로 등등 회사가 요구하는 사항들을 나열하라고 할테고... 이래저래 주석을 못달겠다는 핑계거라면 찾게 되는건 아닌지..

    책임을 돌릴 수는 있어요. 그러면 지금 프로젝트 하는 것을 대상으로 얼마나 시간을 주면 가능한지 계산이 가능한가요? 

    -1
  • baltasar
    6k
    2019-10-09 23:57:47

    //타키투스

    프로그램에 주석을 달아야 한다는 법은 상법이나 민법 몇 항에 있습니까?

    1
  • 타키투스
    867
    2019-10-10 00:03:47

    baltasar 

    어리석네요.. 사회가 법만으로 작동된다고 보시나요? 

    신이 실존하는지 안하는지 증명되야만 그 신을 기반하는 종교의 가치가 있는거라 생각하시나 보네요. ㅋㅋ 


    방가방가2 댓글이나 읽어보시고 댓글을 다시던가.. ㅋ 

    1
  • 타키투스
    867
    2019-10-10 00:05:36

    baltasar


    "글쓴이도 거저 얻으려고만 하지 마시고, 힘들게 코드와 업무를 분석해서 자기 것으로 만들고 누구에게도 절대 알려주지 말고 잘 쥐고 있은 후에, 근로자에게 기술 및 업무 제반을 제공하지 않은 회사와 다음 연봉협상을 할 때 다 보상받으시기 바랍니다. 이런 걸로 연봉협상에서 연봉 올려야지, 절대 회사가 연봉 그냥 안 올려줍니다"


    잘도 글쓴분이 거져 얻으려고만 한다고 생각하시는 모양이네요. 주석 없다고 하소연하면 거져 얻은 거라는 상법, 민법 몇 항에 있나요? ㅋㅋㅋ 

    1
  • baltasar
    6k
    2019-10-10 00:06:14 작성 2019-10-10 00:08:31 수정됨

    //타키투스

    타키투스님이 아래의 글을 적었습니다.

    =================================================================

    '주석이 없어서 이해하기 힘들어지면 비용 부담을 회사가 해야 한다는 건 억지일 수도 있죠. '

    '(프로그램에 주석이 없으면 프로그래머에게) 책임을 돌릴 수는 있어요. '

    =================================================================

    둘 중 한 사람에게 시간과 노동의 부담을 지우고, 책임을 만드는 일인데  도의적으로 되는 일입니까? 법으로 해야 하는 일인데요.

    타키투스님,

    프로그램에 주석을 달아야 한다는 법은 상법이나 민법 몇 항에 있습니까?


    법으로 해석도 못하면서 프로그래머에게 시간과 노동의 부담을 지우고 책임을 지울 생각을 합니까?

    타키투스님은 기본적인 윤리뿐 아니라 상식조차 없군요.

    0
  • 타키투스
    867
    2019-10-10 00:16:31 작성 2019-10-10 00:19:00 수정됨

    baltasar 

    어리석네요.... 독해력이 없으신듯... 


    "규약이고 나발이고.. 개발자라면 주석다는건 당연한 겁니다. 다음에 만들사람을 편하게 하는.. 같은 개발자로서 개발자를 챙기는 일인데도,, 회사의 제도, 규약 운운하는 것보다 차라리 일정 빡빡해서 주석 못단다고 하소연하는게 더 있어 보입니다."


    누가 시간 없는 사람에게 주석달라고 했나요? 제 댓글은 읽어나 보시고 하는 말인지? 시간=돈  당연한거지요. 시간 없으면 주석 달지 않으면 그만 입니다 .하지만 회사가 그것에 대해서 규약을 정하고 이래라저래라 해야한다구요? 

    법 이야기가 나와서 하는 말인데, 프리랜서들에게 주석을 이렇게 다세요, 저래 다세요 구체적으로 지시가 가능 합니까? 


    프리랜서는 고도의 전문성을 담보로 단가를 높게 쳐주는거 아닌가요? 당연히 그 고도의 전문성에 프로그래머로서의 자질이라고 할 수도 있는 코딩 규약이 없는거면 단가 깍아야죠.  그 다음에 그 노동에 쏟아붇는 시간을 이야기 해야하지 않나요? 


    이런거죠. SI 업계가 개판이 된거는 모두 업계 탓이다. 과연? 이런 의문을 한번 해보는거지. 과연 적절한 시간을 주면 퀄리티 높은 소프트웨어가 나올거라고 생각하시나요? 적절한 시간을 주면, 엄격하게 업무처리만을 위한 시간만 꼭 맞게 주면 퀄리터 높은 코드가 나올거라고 프리랜서분들은 자동을 생각하시는 거죠? ㅋㅋㅋ  나는 이미 어마어마한 전문성을 가진 사람이야.. 시간없이 일을주기 때문에 그 전문성을 개발도 못하고 키우지도 못하고 쓰지도 못해.. 과연? ㅋㅋ 


    그리고 자꾸 프리랜서라고 하면서 정규직 처럼 이야기를 하시는데, 그러면 전부 정규직 연봉으로 받으셔야죠.  남보고 법 운운할때가 아니란 거지요. ㅋ 

    0
  • baltasar
    6k
    2019-10-10 00:18:37 작성 2019-10-10 00:20:21 수정됨

    타키투스님,

    도의니 뭐니 전문성이니 뭐니 주저리 주저리 말 늘어놓으면서 논점확대와 화제돌리기 하면서 빠져나갈 궁리 하지 마세요.


    다시 한 번 묻겠습니다.

    프로그램에 주석을 달아야 한다는 법은 상법이나 민법 몇 항에 있습니까?


    법이 해결이 된 후에 도의와 전문성, 책임을 따질 수 있는 겁니다.

    0
  • 온디맨드
    44
    2019-10-10 01:11:12

    누가봐도 당연한 쓸데없는 설명주석이 많은 코드는 쓰레기라 봅니다 

    5
  • 마르세유1
    860
    2019-10-10 06:09:53

    주석없이 읽혀지는 코드가 최선이고

    안되는 부분은 주석을 추가할수밖에 없죠


    추세는 주석은 최신으로 유지하기 힘들고, 오히류 리딩에 방해가 될수있어

    최소한으로 줄이는 쪽으로 가고있습니다

    5
  • setoka
    549
    2019-10-10 07:30:02

    타키투스님// 

    전 주석이 정말 그렇게 중요하면

    주석(및 커밋 로그 등)을 관리하는걸 업무로 판정하고 개발자 연봉 주는게 맞다고 봅니다

    그럴 능력이 되는 사람을 매니저로 쓰던가요


    주석 몇줄 추가하자고 연 몇천만원 몇만불 연봉 추가지출...을 해야 맞는거라는 생각이 드네요

    그게 당연하다고 말하는게 개발자가 개발자를 위하는길 아닐까요

    3
  • 개나소나고생
    5k
    2019-10-10 08:25:22

    주석 없는 곳 은근히 꾀 있습니다.. 저도 이해가 안되긴 하지만 지금 있는 곳도 의도를 전혀 모르는 코드가 일부 있습니다.ㅋㅋㅋ

    1
  • youngyoung
    482
    2019-10-10 08:48:00

    주석 한줄 없으면 난감하죠..

    이거 수정해도 되는건가.. 지워도 되는건가...고민하는 시간을 만들어주는...

    개인적으론 내가 편하기 위해서라도 주석다는 습관을 들이는게..

    인간의 기억력은 생각보다 안좋습니다.

    2
  • 타키투스
    867
    2019-10-10 08:48:26

    baltasar

    논점 흐린적 없는데요.

    세상에 법만 어기지 않으면 뭐든 가능하다고 보는 모양이네요.

    프리랜서 호봉제 인줄 아시나 보네요. 몇년차 얼마 하는게 말입니다. 사람 많은 지하철 출퇴근길에 음식물 들고 낸새 풀기면서 먹어도 아무런 상관이 없는겠네요??

    법법 운운 하시니.. 프리랜서가 받는 돈은 그러면 10단위로 이건 어디꺼 저건 저기꺼식로 평가받고 받으시나요?? 

    법대로 계약을 했으니 돈의 많고 적음을 주석 3줄이면 10만원, 코드 몇백줄이면 몇백만원.. 문서 작성하면 어쩌고.. 그런데 그것조차도 적당한지 않한지 따지면서 돈 받으시나요?

    법대로 말씀하시니, 주석을 단다 칩시다. 그럼 드거 얼마나 하는 주석인지 정량화가 됩니까?? 

    그리고 내 댓글에 당신이 댓글 달라고 법에 장해져 있나요?? 왜 제게 시비 세요?? 

    1
  • 타키투스
    867
    2019-10-10 08:50:14

    그리고 주석 안달고 개발한 코드에 대해서 뭐라하지 말라는 상법 민법 어디 있나요?? 거기다 그걸 누가 작성했는지도 모르는 상황인데요?? 법 위반이라도 된답니까?

    0
  • 부르부르
    2k
    2019-10-10 09:13:45

    지극히 개인적인 생각으론

    유지보수를 용이하고 수정 시간을 단축 시키는데 주석이 상당히 많은 역할을 한다고 생각합니다 ㅎㅎ

    그래서 전 개발이나 유지보수 할 때 주석 무조건 달아놓아요 ㅎㅎ

    다음 사람이 보기 편하게 ㅎㅎ

     

    1
  • namua
    43
    2019-10-10 09:23:13 작성 2019-10-10 09:24:22 수정됨

    //타키투스

    "그리고 주석 안달고 개발한 코드에 대해서 뭐라하지 말라는 상법 민법 어디 있나요?? 거기다 그걸 누가 작성했는지도 모르는 상황인데요?? 법 위반이라도 된답니까?"


    라는말씀은 주석안다는거에 상법민법 없다는말씀과도 같게느껴지네요


    주석을 다는게 개발자본인이 없을때  추후 다른분이 작업하기 편하라고 달아주는거지 굳이 달아줘야할 법도 의무도 없다고봅니다


    주석을달아주는건 다음 사람을위한 '배려'이지 '의무'는 아니라고봅니다

    즉 개발자의 마음이죠

    3
  • 더미
    13k
    2019-10-10 09:25:50

    이건 주석과 별개로 산출물이 없어서 생기는 문제 아닌가요?

    6
  • 초보.
    2k
    2019-10-10 09:29:51

    타키투스 lIlIlIlIlI123


    주석이 당연하다니요??

    웃고 갑니다. ㅋㅋㅋ


    개발소스를 보고 분석을 하는것이 일순위 입니다.

    주석을 보고 분석을 한다면 그것부터가 잘못입니다.


    주석은 참고용이지 필수요소가 아닙니다.

    해당 프로젝트의 코딩 가이트외의 주석은 사용하지 않습니다.



    4
  • 곰라이언
    89
    2019-10-10 09:36:43

    읽기 좋은 코드에 굳이 주석을 달 필요가 있을까요? 그건 불필요한 주석일 뿐이죠

    주석을 달 필요가 있는 경우는 해당 코드를 작성하게된 이유가 반드시 필요한 경우입니다

    2
  • 재현아빠
    1k
    2019-10-10 09:39:00

    주석을 반드시 달아야하는 건 아니라고 생각하구요.

    이런 걸로 이렇게 댓글로 싸우고 할 건 아니라고 생각하는데요..저 사람은 저렇게 생각하는 구나하고 넘어갈 수 있는 여유가 있으면 좋겠습니다. 여기는 자기의 생각이 맞다는 것을 증명하는 곳이 아니니까요.

    그리고, 댓글을 좀 공격적으로 작성하시는 분들은 좀 자중하시면 더 좋을 것 같습니다.

    5
  • mirr
    127
    2019-10-10 09:48:21

    주석이 아예 없는것도 문제가 있다고 지적할수 있지만

    주석을 위한 주석을 다는건 더 문제가 크다고 봅니다.


    정확히 어떤 주석을 달아야 한다는게 아니라 단순히 주석달아야 한다는 정책때문에 

    그냥 함수명, 매개변수명만 함수위에 써넣고 아무런 설명도 없이 주석을 잘달아놨다고 우기는 경우도 많습니다.

    이런경우는 주석이 코드 가독성에 오히려 방해가 되어서 아예 주석없애고 봤었네요.

    쓸데없는 주석을 다는것보다는 주석을 안달고 변수,함수명에 신경을 쓰는게 좀더 좋다고 봅니다.

    주석은 특별한 사항 혹은 히스토리성 정보를 적는게 맞다고 보고요. 사실 잘만든 소스는 주석이 필요없는 경우가 많죠. 


    주석여부는 회사의 관리정책문제라서 개발자의 자질에 엮을껀 아니라고 봅니다. 

    오히려 주석보다는 형상관리형태로 히스토리 관리가 훨씬 중요하다고 생각하고 그런것또한 회사의 관리정책이죠.


    정말 많은 회사에서 형상관리조차 안쓰고 그냥 압축파일로 관리하는 경우가 상당히 많습니다. 

    7
  • GunBBangOFyou
    109
    2019-10-10 09:52:46

    오...

    오늘도 댓글 토론 덕분에 새로운걸 알게된거같네요 ㅎ 감사합니다

    1
  • 뒷집할머니
    1k
    2019-10-10 09:56:55

    자기가 조금 안 다고 그거 가지고 꽁꽁 붙들어매고,

    그걸로 자신의 몸 값 올리는 개발자는 저랑 안 맞더라고요.


    그냥 다 알려주고 그래야 업무도 원활하게 진행되는거고,

    다른 부분으로 승부를 봐야죠.


    1
  • 륜디아
    1k
    2019-10-10 09:59:54

    좀 난해한 코드라던가 따로 의도가 확실히 있는 코드 같은 경우엔 주석을 달아주는게 맞다고 보는데...

    그런거 아님 굳이 달아줄 필요 있나 싶네요.

    무엇보다 달아줄때는 다른 개발자를 위해서 라기 보단 미래의 나를 위해서.... 분명 까먹을테니...

    4
  • 하마
    6k
    2019-10-10 10:19:13 작성 2019-10-10 10:29:01 수정됨
    1.대게 주석은 안 믿고, 코드는 믿음.
    2.책임범위가 명확치 않은 조직에서 코드 로직에 대한 주석은 필요없다 봄 (7번 예외)
    3.주요 모듈에 대한 로직 설명이 필요 한 경우 위키에 따로 정리 하라 함. 
    4. 마법수는 주석 필요
    5. Fixme 는 주석 필요
    6. OptimizeMe 도 주석 필요
    7. 모든 함수에 대한 설명 주석은 팀이 제대로 빌딩 된 후, 각 함수,모듈에 대한 책임자가 분명히 정해져서, 책임을 물을 수 있을 때 넣음.문서화로 사용


    ' OOO 가 당연하다'  ㅡ 조직에서는 개개인의 이런 마인드가 가장 문제
    6
  • 자라선
    1k
    2019-10-10 10:22:01

    모든 코드가 다있어야한다 까진 아니지만

    적어도 누가봐도 아 이건 주석 안달면 몇분동안 분석해야겠네

    라고 할만한거 달아야하지않을까 합니다.


    근데 보통 모든 클래스 및 메소드 블럭단위로 주석달지 않나요?

    javadoc 처럼

    2
  • minarai
    2k
    2019-10-10 10:30:27

    개인적으로 주석없는 코드 극혐합니다.
    뭐 계약이 어쩌고 사회가 어쩌고 하는데
    그건 그쪽 사정이고 결과적으로 남 배려 안하는건 똑같다고봅니다.
    쓴 사람이 일에 찌들여서 못넣은건지 귀찮아서 안넣은건지 확인이 안되기 때문에
    욕 박을 뿐입니다.
    바뻐서 못 넣었으면 맨 위에 한줄로 바뻐서 못넣었다고 써주든지

    0
  • onimusha
    7k
    2019-10-10 10:56:16

    경험상 프로그램 로직이 복잡하다고 주석에 의존해서 다음 번 수정을 하고 다시 주석을 갱신해야하고.. 하는 프로그램 치고 제대로 주석과 코드가 sync 맞는 꼬라지를  본 적이 없습니다;;

    1
  • 유리세계
    2k
    2019-10-10 11:39:50

    주석을 반드시 달아주면 좋다에 동의합니다.


    하지만 윗 분 말씀대로 코드가 수정되고 수정되다보면 주석이 오히려 덫이 되어 발목잡는 경우도 있죠

    코드의 의도를 파악할 수도 있지만 주석채로 복붙하다 아예 의도조차 왜곡될 수 있어요.

    주석은 참고용입니다. 코드에 비해 신뢰도가 떨어져요.


    그런데 개발자가 주석을 보고 개발합니까?

    남이 개발한 코드를 보고 내가 이해한 것에 참고가 되면 됩니다.


    +

    위에 주석달아야 하는 법이 있냐고 하시는 법치주의 분이 계시는데 그만큼 법을 잘 알고 잘 지키고 사는지도 궁금하네요. 법으로 안되어있으면 도의적인 건 얼마든지 무시해도 된다는 걸로 보이네요. 어떤 생각인지는 알겠지만 글이 너무 공격적이라 반감이 듭니다.





    6
  • .getMoney()
    1k
    2019-10-10 12:48:46

    주석이 악의를 가진 함정주석도 간혹 있기에.. 뭐가 정답인지는 모르겠네요


    현재 저같은경우도 주석없는 프로젝트 분석중인데


    상황은 이해가가나 위에서 별다른방안없이 일감을 토스해서 


    저역시도 개발하는건에 대해서 주석없이 개발하고있네요 ^^;

    1
  • .getMoney()
    1k
    2019-10-10 12:50:32

    환경적인 요인으로도 영향을 많이받는 거 같아요.



    1
  • .getMoney()
    1k
    2019-10-10 12:53:14 작성 2019-10-10 12:55:34 수정됨

    주석정도는 가벼히 생각하는게


    현재 서비스 중이며

    프로젝트 히스토리 문서 1도없고 

    형상관리도 없었고

    최신소스 war 로 묶인거1개 

    최신화안된 옛날 프로젝트 1개 

    받아서 분석해서 역컴파일해서 싱크맞추고있는데

    이런상황되니


    저 역시도 주석다는게 당연한건가 싶기도하네요.

    이전 사람이 악한 감정 품고 주석 싹 지우고 퇴사하셨습니다.

    1
  • baltasar
    6k
    2019-10-10 13:33:02 작성 2019-10-10 13:39:04 수정됨

    많은 토론이 있었네요.


    타키투스님의 글 몇 가지를 확인하고 또 질문을 드리겠습니다.

    ---------------------------------------------------------------------------------------------------------------------

    1. "주석이 없어서 이해하기 힘들어지면 비용 부담을 회사가 해야 한다는 건 억지일 수도 있죠."

    그러면 타키투스님은 주석이 없어서 이해하기 힘들어지면 비용 부담을 누가 하라는 겁니까?

    여기서 타키투스님은 "(주석 안넣은)책임을 (개발자에게)돌릴 수는 있어요." 등 프리랜서는 정규직과 달라야 한다며 주석을 달지 않은 개발자가 해당 프로그램의 주석을 책임져야 한다고 댓글을 달았죠?

    분명히 그랬습니다.

    타키투스님, 왜 현행 시스템과 전혀 상관없게 된 이전 개발자가 자기 시간과 비용을 들여서, 회사가 돈을 벌고 있는 회사소유 시스템의 주석을 책임져야 합니까?


    타키투스님 말은 '회사가 개발자보다 중요한 존재이므로 회사가 돈을 버는 데에, 개발자들이 희생하라'는 얘기인가요?

    아니면 '네가 개발했으니 네가 책임져야지!'입니까?

    ---------------------------------------------------------------------------------------------------------------------


    타키투스님,

    본인의 사상이 확고하게 정립된 분이니 불만 가득찬 눈으로 눈팅하시는 거 알고 있습니다.

    저는 타키투스님의 그 사상이 뭔지 잘 알고 있습니다. 그 사상의 실체를 오키회원들에게 보여주고 싶습니다.

    위의 1번 질문에 답변해주시죠?

    0
  • baltasar
    6k
    2019-10-10 13:42:34 작성 2019-10-10 13:44:23 수정됨

    더미님이 제대로 말씀해주셨네요.

    산출물을 보면 됩니다.

    그런데도 주석을 강요하는 이유?

    산출물이 없거나, 코드 하나 하나까지 회사는 가만히 있고 전임개발자에게 시켜서 손 안대고 코 풀려고요!


    방법론 및 조직 개선. 그게 회사가 할 일이죠.

    0
  • youtubemy
    16
    2019-10-10 18:20:45


    여기저기 수십개( 70개 이상)  유지보수로  프로젝트를 본 결과.

    90% 이상 주석 없습니다.

    인수인계도 안 되고 개판인 것이 대분인데요.

    주석을 달리겠습니까?

    일정에 촉박하고 대부분 사장 배부르는 프로젝트가 대부분인데요  누구 좋으라고요. ?

    그리고 이것이 정상 아니 겠습니까? 




    자기가 프로젝트를 하면서 주석을 달고 꼼꼼히 한다면,

    제 개인적으로 생각하기에는 

    괜찮은 업체 이거나, 일정에 여유가 있거나  아니면 괜찮은 개발자 분 입니다.




    1
  • fender
    14k
    2019-10-10 18:39:35 작성 2019-10-10 19:04:13 수정됨

    우선 고백부터 하면 전 주석을 거의 달지 않는 습관이 있습니다. 구문 단위의 주석은 특별한 경우가 아니라면 필요하지 않다고 보긴 하지만, 솔직히 API 수준의 주석도 달지 않는 건 제 스스로도 나쁜 습관이라고 생각합니다.

    위의 논쟁을 대략 훑어 봤지만 여기서 왜 법 이야기가 나오는지 모르겠습니다. "법은 도덕의 최소한이다"라는 말에서도 알 수 있듯이, 법에 저촉만 되지 않는다면 무엇을 해도 무방하다는 논리는 성립하지 않습니다.

    이는, 여기서 '도덕'을 '개발자로서의 상식' 쯤으로 치환해도 충분히 성립하는 이야기로, 위법만 아니라면 뭘해도 좋다는 식이라면 주석을 안다는게 문제가 아니라 메서드 이름을 죄다 애니메이션 캐릭터 이름으로 달아도 위법은 아닐 겁니다.

    2
  • sorrymommy
    73
    2019-10-10 18:39:54 작성 2019-10-10 18:47:40 수정됨

    어떤 주석을 말하는지 모르겠지만


    책에서 배운 내용과는 다르게 현대 프로그래밍에서 주석은 가급적이면 안다는게 좋다고 생각하는 편입니다.


    바꿔말하면 주석을 달지않고도 충분히 이해되는 코드가 가장 좋은 코드라고 생각합니다.


    그러기 위해서는 명명법에 많은 신경을쓰고 변수, 메서드, 클래스 이름을 함부로 짓지 않아야 합니다.


    그럼에도 불구하고 주석이 없을 경우 이해하기 어려울 경우에 주석을 달아야 하죠.


    클래스의 사용이나 이런 주석이 아닌 그냥 '뭐하는 메서드' 이딴식의 주석은 필요가 없습니다. 메서드명으로 그 의미를 명확하게 하면됩니다.


    어디까지나 개인적인 경험입니다. 저의 경험으로는 여태 일하여 개발자들의 주석과 코드를 봤을 때


    주석을 잘 다는 개발자 보다 주석을 굳지 달지 않아도 되는 코드를 만드는 개발자가 월등히 더 유능하며 실제로 가보면 이런 개발자일 수록 코드로 이해하기 어려운 상황에는 매우 친절하게 주석을 달아 놓는 경우가 많습니다.


    반대로 주석을 덕지덕지 다는 스타일의 개발자의 경우 코드가 개판인 경우가 더 많고. 그리고 주석의 갱신도 일루어지지 않고 주석의 내용과 코드가 어긋나는 경우가 허다하였습니다.


    어디까지나 개인적인 경험이지만 15년 넘개 개발하면서 이 법칙을 벚어나는 경우를 못 봤습니다. 특히 주석을 강조하는 개발자일수록 코드의 질이 떨어지는 경우가 많았습니다. 이는 코드의 질을 높여서 이해를 높이는 방법보다 그냥 주저리 글을 쓰면 이해가 쉽다고 생각하는 것이 기인하지 않나 생각해봅니다.


    그리고 실제 코드로 이해를 하기 쉽도록 하기 위해서는 상당히 공을 많이 들어야 합니다. 그냥 메서드 이름 하나지만 고민하고 통상적인 방법이 무엇인지 대부분의 대가들은 왜 이거 쓰는지 나름의 철학을 가지고 만드는 경우가 많았고 사용자 입장에서 사용하기 쉽게 메서드를 만들기 위해서 온갖 객체지향 테크닉이 다 활용되는 경우가 더 많았습니다. 하지만 주석 맹신론자들은 메서드명하나 이해하기 쉽게 짓지 못하는 경우가 허다 했습니다. 가령 getXXX 메서드를 쓰면서 반대변에 대입될 변수조차 있지 않고 하지만 작동이 되는코드를 볼때 참.. 한심하다 싶을 정도 였습니다. 뻑하면  'Check 뭐시기' 변수명이 허다하고 영어는 분명 동사가 먼저고 명사가 뒤에 있음에도 메서드 명에 명사 먼저 동사 후를 붙여 쓰지를 않나 전치사 전치사를 붙여서 명명하지 않나 암튼 생각하기 싫을 정도로 하수들이 널렸던 기억이 대다수입니다.


    그리고 하이라이트가 주석 맹신론자보다 코드로 주석을 대체하도록 개발하는 사람들의 코드에 있는 주석은 쓸모있는 주석이라 느껴지는 경우가 99%라면 주석맹신론자들의 주석은 거즘 5%이하 정도만이 주석이 주석다운 가치를 가지고 있었습니다.


    어디까지나 개인적인 견해이고 경험이지만 저는 아직 이 룰을 벗어나는 개발자를 본적이 없어서 주석을 강요하는 개발자는 솔직히 색안경을 쓰고 볼 것 같습니다.


    그리고 읽기좋은 코드가 주관적이라고 하는데 코드니까 주관적일 수 있지만 솔까말 코드 좀 보면 실력 다 나오지 않습니까?


    상대방의 코드가 이해가 가지 않는다고 느껴진다면 솔직하게 저의 경험으로는 상대보다 실력이 낮은 경우였습니다. 그렇기 때문에 주석을 달아야 한다고 한다면 그 의견에는 반대합니다.


    팀내 동료들의 코드 수준이 다 다르기 때문에 하양편준화를 하는 것에는 찬성하지 않는 이치와 같습니다. 하지만 코드는 이해가나 왜 이렇게 했는지 당위성이 느껴지지 않는 코드를 만드는 개발자와 대화를 해보면 저보다 한수 아래였습니다. 뭐 한수 아래 위가 중요한 것 아닙니다. 사고방식이 유연한가 아닌가가 더 중요한 가치라 생각합니다.


    바꿔말하면 주관적이라서 개개인이 다르다고 하는데 어느정도 수준이상이 되면 무조건 주관적으로 보이지않다고 생각하는 편입니다.


    특히 하수들은 코드에 당위성이 없습니다. 왜 이 이름을 써야되고 이런 클래스가 만들어졌는지 자신의 코드에 그런 맥락이 없습니다. 잘 못된 구성이라도 맥락이 있어야되는데 그런 맥락이 없는 코드를 만드는 개발자들 대다수들이 주석맹신론자였기 때문에 저는 주석 맹신론에 좀 반대의견을 표하고 싶습니다.


    6
  • 콘푸로스트
    773
    2019-10-13 22:45:32 작성 2019-10-13 22:46:51 수정됨

    주석은 필요한 곳에 누가봐도 이해할 수 있을만큼만 달면 됩니다.

    해석이 필요없는 곳에 주석을 달 필요는 없죠.

    그렇다고 모든 코드 부분이 해석이 필요없는 건 아니죠.

    해석하는 것도 개인 역량이라 주석이 필요없다고 판단되면 안 다는거죠.

    참 아이러니합니다.


    저는 중요 업무가 들어가는 코드에는 왜 이래야하는지(수정할 때 조심하라고) 주석을 달아줍니다.

    (내가 실수할까봐... 그리고 기존에 있는 주석 믿고 개발하다가 큰일납니다. 참고는 할 수 있지만 주석을 믿지마세요.)

    1
  • NULL만나면
    2k
    2019-10-14 13:27:42

    저도 최근에는 주석 자제합니다.


    보통 딱 한 줄 남기는데 외부링크 입니다.


    이슈 트래커요. 거기서 관리합니다.

    2
  • 와키키킹
    49
    2019-10-14 16:07:59

    주석 문제가 아니라 인수인계와 추가적인 문서가 없어서 해결을 못하시는 상황 같아 보이네요.

    주석은 가급적이면 안다는게 맞고 주석을 회사에서 정해놓은 코딩 가이드에 따라 작성하는게 맞아 보이고요..

    1
  • 7i
    1k
    2019-10-15 00:31:02

    저는 변수명, 함수명, 파라메터등을 지을때 신경을 많이 써서 만듭니다.

    주석을 한줄도 안달기 위해서...


    1
  • cat11
    372
    2019-10-15 08:03:21

    주석까지 버전관리가 안될가능성이 크기에 신뢰도가 떨어진다고 생각합니다

    주석이 있으면 코드안보실건가요?

    어차피 주석은 참고용도라고 생각합니다

    주석보고 파악했는데, 나중에 알고보니 중간에 수정했을때 주석은 안고쳤다면?


    주석의 범위, 주석을 어떻게 달것인지 등등에 대해 팀에서 정한 범위만큼 하는게 맞는거 같습니다

    1
  • crazygun22
    609
    2019-10-16 10:58:08

    주석이 있고 없고가 문제가 아님.


    0
  • extreme
    749
    2019-10-16 12:02:38

    주석이 필요한 건 맞지만 그 쓰임이 중요한 것 같습니다. 누가봐도 명확한 내용에 주석을 달아놓고 주석은 업데이트 하지 않고, 코드만 변경되어서 주석과 코드가 따로인 상태도 너무 많이 봐왔고요. 마치 변수명에 타입을 같이 적어주던 예전 헝가리안 표기법을 보는 느낌이랄까요? 분명 Int라고 이름이 되어있는데 실제 타입은 Float이고 ...

    의도가 명확하게 드러나지 않거나 Workaround인 경우에는 주석이 많은 도움이 됩니다.


    0
  • 예상일 뿐이지만

    만약 회사에서 야근해가면서 일정에 쫓겨서 개발했던 환경이라면 

    저라도 달지않을것같은데요...

    무조건 주석 달아야된다는 분들은

    맨날 야근하면서 일해도 자는시간 줄여가면서 주석을 달아줄건가여?


    개발당시 회사가 일정을 타이트하게 잡고 개발자를 압박했다 -> 회사잘못

    개발일정이 충분히 여유가있는 환경이었고, 회사 코딩규칙이 주석을 달도록 명시되어있었으나 의도적으로(귀찮아서 or 다음 개발자 짜증나라고 or 회사 엿먹으라고) 안달았다 ->개발자잘못


    당시 상황을 모르는데 무조건 달아야된다고 하는분들은 뭐죠...

    옆에서 마피아가 머리에 총들이밀고 계산기 프로그램 빨리 안만들면 총쏜다고해도 주석다실건가;

    상황을 모르니만큼 지금시점에선 법적으로 문제가 없으면 안달아도 문제 없다는게 맞는거 아닌가요


    0
  • atw36
    18
    2019-10-16 16:49:39

    주석이 정말 없었을까요???

    다지운거 아닐까요???

    0
  • baltasar
    6k
    2019-10-16 16:55:13 작성 2019-10-16 16:58:00 수정됨

    만약 전임개발자가 주석을 다 지워버린 것이라면 그는 정말 도덕적으로 훌륭한 사람이죠.

    후임에게 '이곳은 경영진이 정신병자들 같고 근무환경이 똥같은 곳이며, 나중에 가서 뒤통수를 크게 맞아 머리가 깨지는 곳이니 절대 오지 마라.'는 실마리를 남긴 겁니다.

    그러고보니 예전에 LG 대법원 사업때 개발자들이 주석으로 개발일지와 이슈내용을 남기면서 많은 개발자들을 똥통에서 구해내었습니다.(그런데 그렇게 주석을 달게 되니까 문제가 생겼죠. 차라리 주석은 싹 다 지워서 눈치를 주는 것이 낫습니다.)

    후임자도 똑같이 당할 위기에서 구해준 것이니 전임자에게 감사하세요.

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