오늘 기록하거나 내일 회개하십시오!

당신이 무리 사냥꾼이든 고독한 늑대이든 문서화는 코드의 핵심입니다. 적절한 문서화 없이 작성된 코드가 히브리어로 된 텍스트와 같다는 데 동의하지 않습니까? 우리 모두 알고 있기 때문에 프로그램의 범위가 커짐에 따라 세부 사항을 기억하는 것이 불가능해집니다. 그렇기 때문에 모든 노련한 프로그래머는 문서화가 좋은 것과 좋은 것을 구별하는 비법이라고 주장합니다!
팀에서 작업하는 동안 인코딩한 변수와 함수는 다른 사람이 액세스해야 합니다. 동료 동료는 새로운 요구 사항에 대처하기 위해 이후 버전에서 작업을 사용할 수 있습니다. 어수선한 암호 명령은 이유 없이 두뇌를 긁게 만들 것입니다!
글쎄, 당신이 단독 기여자이고 손등처럼 코드를 알고 있다면? 하지만 6개월 후에 코드의 일부를 검토해야 한다면 어떻게 해야 할까요? 무수한 변수와 무수한 함수의 어수선함은 당신을 혼란스럽게 만들 것입니다! 적절한 문서 없이 서둘러 앞으로 나아가는 것은 페니 현명한 파운드 바보가 되는 것과 같습니다.

문서화의 중요성을 이제 깨달았을 것입니다. 다음은 코드를 문서화하는 동안 기억해야 할 세 가지 팁입니다.
1) 헤더 - 각 섹션의 시작 부분에 프롤로그를 배치합니다. 사용된 데이터, 목적, 기능 및 기본 프로그램에 대한 변경 사항과 같은 세부 정보를 포함하십시오. 전역 변수에 대한 변경 사항을 추가하는 것을 잊지 마십시오! 논리적 흐름과 알고리즘을 간략하게 작성하십시오. 복잡한 논리가 관련된 모든 곳에서 정보를 최대한 명료하게 만드십시오.

/**** HEADER
 * purpose of function-
 * returns and error codes-
 * business logic-
 * Additional notes-
****/

2) 본문- 멋지게 들여쓰기되고 주석이 달린 코드는 디버그하기 쉽습니다.
따라서 문서를 짧고 간단하면서도 설명적으로 유지하십시오. 중요한 세부 사항을 포함하는 것은 필수 불가결하지만 다음과 같은 댓글이 있는 앵무새가 되고 싶지는 않습니다.count++; /*increase counter by one*/
3) 변수 이름 지정 - 변수가 보유한 정보는 이름에서 분명해야 합니다. 두 개의 동일한 이름의 변수가 어리석은 오류로 이어지는 것을 경험하셨을 것입니다. 기능에 레이블을 지정하는 동안 블랙박스 처리를 방해하지 않도록 주의하십시오.

/*correct*/
RandomNumberGenerator();
Random_Number_Generator();

/*incorrect*/
randgen();//unclear wording
StochasticStatsticalRandomGenerator();
 /*no black-box treatment of function*/

따라서 문서가 없는 코드는 날카롭지 않은 칼이라는 결론을 내립니다!!