여러분은 코드 주석 처리 어떻게 하시나요? 정보
여러분은 코드 주석 처리 어떻게 하시나요?
본문
예를 들어
새롭게 작성한 코드의 라인수가 있을때, 시작과 끝의 주석을 어떻게 다시는지...
아니면 한줄일 경우에는 어떻게 다시는지~ 이전 코드를 보다보니 문뜩 주석을 더 잘 달아둬야 겠다는 생각이 들어
다른 분들은 어떻게 하시나 궁금해서 여쭈어 봅니다^^
ps. 한겨래 개발자님의 코드 주석이라네요~~ http://wayuare.tistory.com/875
추천
0
0
댓글 12개
가끔 사이트 가다보면
소스보기해보면 중소기업 사이트도 가끔
이건 이렇게해야되고 이건 저렇게한거임 ^^ <<이렇게 이모티콘도 쓰더군요
한겨레계발자님 인간적이시네요 ㅋㅋ
전
/*
*/
//
이것만 씁니다.
소스보기해보면 중소기업 사이트도 가끔
이건 이렇게해야되고 이건 저렇게한거임 ^^ <<이렇게 이모티콘도 쓰더군요
한겨레계발자님 인간적이시네요 ㅋㅋ
전
/*
*/
//
이것만 씁니다.
긴 설명을 써야 하는 주석은
/**
*
*/
그냥 간략한 설명은 //
코드블록 내에서는 /* */ 를 쓰지 않음.
(일부 코드 전체를 주석처리 해야 하는 경우에 저게 들어가면 귀찮아짐)
/**
*
*/
그냥 간략한 설명은 //
코드블록 내에서는 /* */ 를 쓰지 않음.
(일부 코드 전체를 주석처리 해야 하는 경우에 저게 들어가면 귀찮아짐)
맞아요 /* 딱 씌웠는데 중간에 /**/ 들어가있으면 낭패 ㅜㅜ
/* */ 이걸 쓸 정도의 코드를 만들어 본 적이 없어서...
// 거의 이걸로 끝나요.
// 거의 이걸로 끝나요.
저는 # 으로 쓰고 싶은데 다들 // 로 사용하셔서 그냥 대세를 따르고 있습니다. ㅠㅠ
// /* */ 요거 주로쓰고
요런 스타일도 가끔 쓰네요
/*************
** 가나다
**************
//------------
// 가나다
//------------
요런 스타일도 가끔 쓰네요
/*************
** 가나다
**************
//------------
// 가나다
//------------
프로그램 헤더내용에 해당되는 주석들은 /* #################### */ 나 /*********************/와 같이 강조의 의미로 반복 기입하고 일반적인 경우 //를 넣죠. 또 어떤 패턴이나 주기를 갖고 반복 수정되는 라인들은 수정 일을 간략기입합니다.
전 온리 // 이것만 씁니다.
//
// 이거슨 시작임!!
//
모 요딴식으로요!~
//
// 이거슨 시작임!!
//
모 요딴식으로요!~
저도 껴도 되나 모르겠지만..
의무적으로 달아야하는 주석 - 예를 들어 메소드,클래스 헤더의 자동생성주석이나 그 외의 파일헤더 주석 등은 형식이 정해졌으니 예외로 하고,
이하는 어쩔수 없이 해야하는 코딩컨벤션입니더.
/**
* 요건 부분적 프로시저나 함수 내에서도
* 일정한 로직을 전체적으로 설명할 때 여러 줄 달 주석일 경우
* 이클립스같은경우 '/**' 이것만 타이핑하면 자동으로 줄 맨첫라인이 * 이게 붙어서
* 이 형태의 주석이 가능하죠..
*/
-- 물론 쿼리 주석은 대부분 이걸 씁니다.
/* 코드 여러 문장에 대한 설명인 경우 이런주석. 특정 작업 전체를 설명하거나 작업 내용 설명일 경우... 코드 윗부분에 ..*/
// 코드 한 statement에 대한 주석인 경우 이 주석. 코드 윗부분에 적을 경우는 코드가 짧을 경우고,
// 코드 한문장이 길면 코드 바로 위에 ..
여기까지가 주로 공통적인 코딩컨벤션이라서 따르지 않으면 욕먹습니다.^^;
결론 : 자유는 없다.
의무적으로 달아야하는 주석 - 예를 들어 메소드,클래스 헤더의 자동생성주석이나 그 외의 파일헤더 주석 등은 형식이 정해졌으니 예외로 하고,
이하는 어쩔수 없이 해야하는 코딩컨벤션입니더.
/**
* 요건 부분적 프로시저나 함수 내에서도
* 일정한 로직을 전체적으로 설명할 때 여러 줄 달 주석일 경우
* 이클립스같은경우 '/**' 이것만 타이핑하면 자동으로 줄 맨첫라인이 * 이게 붙어서
* 이 형태의 주석이 가능하죠..
*/
-- 물론 쿼리 주석은 대부분 이걸 씁니다.
/* 코드 여러 문장에 대한 설명인 경우 이런주석. 특정 작업 전체를 설명하거나 작업 내용 설명일 경우... 코드 윗부분에 ..*/
// 코드 한 statement에 대한 주석인 경우 이 주석. 코드 윗부분에 적을 경우는 코드가 짧을 경우고,
// 코드 한문장이 길면 코드 바로 위에 ..
여기까지가 주로 공통적인 코딩컨벤션이라서 따르지 않으면 욕먹습니다.^^;
결론 : 자유는 없다.
좋은 말씀 감사합니다^^
참고해서 좋은 주석 달 수 있도록 하겠습니다~
참고해서 좋은 주석 달 수 있도록 하겠습니다~
주석을 문서작성하 듯 하는 것도 나중에 볼 때 필요한 부분이겠죠.
올려 사용할 때는 복사해 가급적 주석을 삭제하고 압축해 사용하는 것도
한 방법이겠습니다 ^^
올려 사용할 때는 복사해 가급적 주석을 삭제하고 압축해 사용하는 것도
한 방법이겠습니다 ^^
//든 /* 이거든...
뭔가 주석이 많이 들어가는거면.. 최하단에 간단히 주석 요약까지..
뭔가 주석이 많이 들어가는거면.. 최하단에 간단히 주석 요약까지..