기본적으로 CodeIgniter 한글메뉴얼에 정의된 사용규칙을 잘 준수해 주면 큰 무리는 없는것 같습니다.
하지만 프로젝트 작업을 하다보면 추가적인 코딩 컨벤션을 준수할 경우가 생기게 되는데요..
특히 주석달기 부분이 중요할것 같아서 올려보게 됩니다.
<CI 코딩시 주석달기>
메쏘드나 함수에 주석을 정리해 두면 프로젝트를 완성후 phpdoc 자동문서화를 통하여 다른 사람들이 이해하기 쉽게 정리를 해주는것이 좋기 때문입니다.
=> 사용예) 이클립스에서는 /** 를 치고 엔터를 치면 다음과 같이 주석을 만들 수 있습니다.
/**
*
* @return unknown_type
*/
=> 이클립스 추가 환경설정 : Code Templates나 Formatter 을 통하여 좀더 다양한 설정이 가능합니다.
<검색추천용어>
1. Coding Convention : http://blog.naver.com/airdasom?Redirect=Log&logNo=90010786325
2. 이클립스 주석 : http://blog.naver.com/rapkuma/20036011030
3. 헝가리언 표기법 : http://blog.naver.com/chsropy?Redirect=Log&logNo=130014807000
|