짤방은 예전에 강의들을때 쓴 교육용 코드 예시로 든건데
(짤방 위에 40줄의 include 와 주석이 더 있음ㅋㅋ)
전체 시스템 디자인한걸 코딩할때마다 다시 보지 않기 위해
일부 큰 클래스나 함수는 위처럼 패러미터나 내부 변수 주석 하나하나 다 해놓고
이러한 예외 케이스에선 리턴값이 0이 아닌 다른 값으로 정의한다 이런거까지 다 작성해둬요.
사람마다 스타일이 다를테니 뭐... 전 주석 많이 하는 편입니당!
짤방은 예전에 강의들을때 쓴 교육용 코드 예시로 든건데
(짤방 위에 40줄의 include 와 주석이 더 있음ㅋㅋ)
전체 시스템 디자인한걸 코딩할때마다 다시 보지 않기 위해
일부 큰 클래스나 함수는 위처럼 패러미터나 내부 변수 주석 하나하나 다 해놓고
이러한 예외 케이스에선 리턴값이 0이 아닌 다른 값으로 정의한다 이런거까지 다 작성해둬요.
사람마다 스타일이 다를테니 뭐... 전 주석 많이 하는 편입니당!
아재요 함수쪽 주석 어떻게 저리 질서있게 만들어요? 일일이 띄어쓰기 하는건 아닐거고
파라미터 갯수에서 이미 정신이 혼미해진다. 이런 코드에선 확실히 주석이 필요하겠네
주석도 좋지만 e 같은 변수명은 error나 numError 같이 만들면 주석이 없어도 이해하기 편할텐데
빌더 패턴을 적용하고 파라미터 이름을 직관적이게 변경하면 더 나은 코드가 되지 않을까요 팩토리 메서드 치고도 인자가 많네요 - dc App
나도 저렇게 일일이 다 주석을 달지는 않지만 한 반 정도는 달아둠 안그럼 나중에 버그 찾거나 최적화할때 헷갈리고 오래걸리더라
지금 코드에서 저 패러미터는 최소화 한거에여... dbms 에서 돌아가는 함수 중 하나 그대로 가져온거임. 코드 원 출처는 카이스트
멍청해서 띄어쓰기 노가다 합니다
함수 헤더주석만 하고 함수 내부주석은 최대한 자제
줄맞추기는 에디터빨로 해결하세용