The DoYouHaoBaby PHP Framework中文开发文档手册
Copyright(c) DoYouHaoBaby.NET All Rights Reserved.
The DoYouHaoBaby PHP Framework中文开发文档手册
主页　 上级
[ 程序头注释块 ]
每个程序头部必须有统一的注释块，规则如下：
  1. 必须包含本程序的描述；  
  2. 必须包含作者；
  3. 必须包含项目名称；  
  4. 必须包含文件的名称；
  5. 可以包含书写日期；
  6. 可以包含版本信息；
  7. 重要的使用说明，如类的调用方法、注意事项等；

当然这只是一个参考，DoYouHaoBaby就不采用这种方式，而是采用一种大气的方式。这个可以根据习惯来做，不要太拘泥。


参考例子如下：

  1. /**================================== NOT TM ==================================**\  
  2.              ----+-+-+-+-+-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+-+-+-  
  3. 这个文件是 < DoYouHaoBaby Framework > 的一部分，该项目和此文件 均遵循 GNU 自由软件协议  
  4.              -+-+-+-+-+-+-+-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+----  
  5. @--------------------------------------------------------------------------------@  
  6.   /+  
  7.   /+        The DoYouHaoBaby PHP Framework | 小牛哥PHP应用程序框架  
  8.   /+   -------------------------------------------------------------------  
  9.   /+           代码行云流水 - 开发如此简单 { NOT TM ~ BUT TMD }  
  10.   /+  
  11.   /+    Copyright (c) 2010 - 2011 http://doyouhaobaby.com All rights reserved.  
  12.   /+  
  13.   /+  
  14.   /+    “DoYouHaoBaby” 的正式全名:  
  15.   /+    ┌----------------------------------------------------------------  
  16.   /+----| “The DoYouHaoBaby PHP Framework”,中文名为“小牛哥PHP应用程序框架”  
  17.   /+    └-----------------------------------------------------------------  
  18.   /+  
  19.   /+    “DoYouHaoBaby” 的由来:  
  20.   /+    ┌----------------------------------------------------------------  
  21.   /+----| 记得高中的时候,有一个女同桌很可爱,聊天很投缘,渐渐喜欢上了,感觉很幸福~  
  22.   /+----| 中间省略一万字......不知过了多久......腼腆久了......朦胧久了......她不见了......毕业了.......  
  23.   /+----| 自己QQ号昵称改为"DoYou好?Baby"即"do you 好? baby",意思是"宝贝你好吗?",仅以此表达对她的深切思念...  
  24.   /+----| 时过境迁,如今这个名字也失去了意思,改了一下,变成了DoYouHaoBaby,同时将自己的QQ昵称改成了小牛哥Dyhb.  
  25.   /+----| 如今的DoYouHaoBaby是我一直想注册的一个商标,这是一个关于DoYouHaoBaby的梦想,毕业后希望自己去实现...  
  26.   /+    └----------------------------------------------------------------  
  27.   /+  
  28.   /+    “DoYouHaoBaby” 的软件许可:  
  29.   /+    ┌----------------------------------------------------------------  
  30.   /+----| DoYouHaoBaby是一个开源项目，正如我们的口号"NOT TM,BUT TMD"所表达的一样，你可以毫无顾忌地使用.  
  31.   /+    └----------------------------------------------------------------  
  32.   /+  
  33.   /+    “DoYouHaoBaby” 的程序开发:  
  34.   /+    ┌----------------------------------------------------------------  
  35.   /+----| DoYouHaoBaby 由国人技术团队开发维护，是一个怀有梦想的项目.  
  36.   /+    └----------------------------------------------------------------  
  37.   /+  
  38.   /+  
  39.   /+    “相关的链接”:  
  40.   /+          [主页] * http://doyouhaobaby.com  
  41.   /+    [GoogleCode] * http://dyhb-frame.googlecode.com  
  42.   /+          [社区] * http://bbs.56swun.com  
  43.   /+  
  44.   /+    <------ End Project Introduce ------>  
  45.   /+  
  46.   /+  
  47.   /+    “本文件相关”:  
  48.   /+          [File] * DoYouHaoBaby.php  
  49.   /+   [Description] * DoYouHaoBaby Framework 内部系统入口文件  
  50.   /+       [license] * GNU General Public License 2.0  
  51.   /+        [Author] * 小牛哥Dyhb  
  52.   /+         [Motto] * 别人笑我太疯癫,我只是疯狂php那点事  
  53.   /+  
  54. @--------------------------------------------------------------------------------@  
  55.       ----+-+-+-+-+-+-+-+- Copyright (c) [DoYouHaoBaby!] -+-+-+-+-+-+-+-+----  
  56. \**================================== BUT TMD ==================================**/  

 

主页
上级