1
다른 사람들이 함수 헤더에서 데이터베이스 사용을 문서화하면 궁금합니다 ... 예를 들어 fn()은 데이터베이스 (또는 테이블)를 읽거나 쓰거나 데이터베이스 또는 테이블을 작성, 수정 또는 삭제할 수 있습니다. (측면 질문 : "USE xxx"를 사용하여 데이터베이스를 변경하는 fn()은 항목의 현재 데이터베이스를 '기억'하고 종료 전에 다시 사용해야합니까?)PHPdoc로 데이터베이스 사용을 문서화하는 방법은 무엇입니까?
은 문서화되어 있어야하지만 어떻게 그렇게 최선입니까? @uses 또는 무엇? 비즈니스 프로세스 X에 대한 매개 변수를 보유 "
/**
* Some comments here.
*
* Helper functions:
* * {@link someHelper}
* * {@link theOtherHelper}
*
* Reads tables:
* * {@link Table1}
* * {@link Table2}
*
* Reads/Writes tables:
* * {@link Table3}
* * {@link Table4}
*/
는 그런 다음 간단한 설명 아무것도하지만, 해당 테이블에 대한 몇 가지 주제 페이지를합니다