星期三, 9月 29, 2010

PHP file 註解

一直不知道檔案註解 應該要寫些什麼
網路上看到針對PHP做的 就學學吧
從別人網站截錄過來看
  • Title - What is your script or mod called
  • Author - You name, and the name of anyone who helped or who's work you modified
  • Version - What version of the script is this? 1.0? 2.3? etc....
  • Installation Time - An idea of how long it will take the user to be up and running.
  • Included Files / Edited Files - This is a list of files that are part of your script, and in the case of a mod, files that will need to be edited.
  • Licensing - Make sure it's clear how the user may and may not use your script.
  • History - History of the mod including the change log of all previous versions.
  • Other Notes - Any other information you want to include about your script, including your support website (if you have one) or other information that may be useful

/*
 *  @Title:
 *  @Author:
 *  @Version:
 */

Reference
PHP Author Notes

沒有留言: