Codeigniter 프로젝트에서 PHPDOC를 실행할 때 어떤 폴더가 포함되어야합니까?
-
22-07-2019 - |
문제
첫 번째 시도에서는 시스템/애플리케이션/모델, 시스템/애플리케이션/컨트롤러, 시스템/애플리케이션/도우미 및 시스템/애플리케이션/라이브러리 만 포함했습니다. 나는 그 폴더에 앞으로 참조 할 수 있도록 올바르게 문서화하려는 코드가 포함되어 있다고 생각하기 때문에 그 폴더를 선택했습니다. 어떤 다른 폴더가 포함되어야한다고 생각하십니까?
해결책
자신의 코드 측면에서 철저하게. 다음 폴더를 추천하고 필요한 경우 주석을 달았습니다.
- 시스템/응용 프로그램/컨트롤러
- 시스템/응용 프로그램/도우미
- 시스템/응용 프로그램/후크 - 이것을 놓치지 마세요! CI 코어를 변경/연장 할 때마다 확실히 문서화해야합니다.
- 시스템/응용 프로그램/모델
- 시스템/애플리케이션/라이브러리
- 시스템/응용 프로그램/언어 - 이것은 현지화를 구현할 때 유용 할 수 있습니다
- 시스템/플러그인 - 라이브러리를 포함시킬 때 사용중인 외부 플러그인도 포함하는 것이 합리적입니다.
다른 팁
나는 당신이 그것을 덮었다 고 생각합니다. 나머지는 아마도 Codeigniter의 문서에 이미 문서화되어있을 것입니다.
플러그인/라이브러리/이 폴더 외부에 있어야하는 모든 것을 추가하면 나중에 추가하십시오.
제휴하지 않습니다 StackOverflow