×
Crocus
공부한 내용을 정리하는 블로그로 시작한
Crocus는 2014년 1월 14일 부터 시작하여
현재 월 6만명, 총 2,588,392명의 방문자 수를 기록하고 있습니다.
Donation
이제 많은 사용자들이 이용하는 만큼
더 다양한 서비스 개발/제공을 위해 후원금을 모금하고자 합니다.
후원을 해주시는 분들은 Donators 명단에 성명, 후원금을 기입해드리며
Crocus 블로그가 아닌 다른 곳에 정리해둔 저만의 내용을 공유해 드리고자 합니다.
Account
예금주 : 고관우
신한은행 : 110-334-866541
카카오뱅크 : 3333-01-7888060

👉 후원 페이지 바로가기 Donators
익명 : 5000원(Crocus응원합니다.)
busyhuman: 5000원(유용한 지식 감사합니다.)
익명 : 5000원(알고리즘 학습러)
반응형

1. 사전 주석 

 

   변수들의 이름과 그에따른 하는 역할을 적어주는 사전을 만들어 두면  

   나중에 다른 프로그래머가 이 코드를 볼때 유용하다. 

 

2. 의사 코드

 

   Class에서 이용하면 좋을 것 같다. (모듈 제작시) 

   이 코드가 어떤 역할을 하게 되는지 상세히 알려주면  

   코드 해석에 어려움이 사라질 것이다 ( 타인이 볼 때 ) 

 

3. 프로그램 목적

 

   프로그램 목적을 주석으로 달아놓으면 저작권 역할도 하고  

   다른 프로그래머가 참조 할 때 역할군을 제대로 이해 할 수 있게 된다.

   (작성일, 장소, 작성자 , 코드성격, 작성목적 , 작성환경 등등) 

 

4. 머리 주석

 

   파일명 , 장성자 , 목적 , 사용방식(코드 사용법) , 사용 파일 (어떤 파일들끼리 연동되는지) 

   제한 사항(만지면 안될 것 등), 오류 처리(어떤 오류가 발생시 어디에 저장되는지 등등)

   이력 사항(버전이 최신화 될때마다 기입한다.), 코드 역사(어떻게 변해오고 있는지 버전) 등등 

 

   ** 프로그램 목적, 머리 주석은 함께 달아도 좋을 듯 하다 ** 

반응형