2011-02-04 10 views
1

私はfn()がデータベース(またはそのテーブル)を読み書きしたり、データベースやテーブルを作成、変更、または削除するなど、他の人がデータベースの使用状況を関数ヘッダーで文書化しているかどうか疑問に思っています。 (側の質問: "USE xxx"を使用してデータベースを変更するfn()は、現在のデータベースを記憶しており、終了する前に再度使用してください)。文書化されるべきですが、それを行うにはどうすればよいですか? @uses、または何ですか?PHPdocでデータベースの使用状況を文書化するには?

答えて

1

なぜヘルパーのリストとともに、@link、リストを使用していない:

/** 
* Some comments here. 
* 
* Helper functions: 
* * {@link someHelper} 
* * {@link theOtherHelper} 
* 
* Reads tables: 
* * {@link Table1} 
* * {@link Table2} 
* 
* Reads/Writes tables: 
* * {@link Table3} 
* * {@link Table4} 
*/ 

は、その後、あなたが簡単な説明が、何もして、それらのテーブルのためのいくつかのトピックのページを作り、「ビジネス・プロセスXのためのパラメータを保持"

関連する問題