[试用]：OXARX代码文档模板

fylinwater

OXARX代码文档模板：
  采用文档和程序代码静态合并的方式，文档通过带标志的注释存在于源代码文件中,如函数头注释。最后利用工具程序提取文档的注释生成相关文档。
注释关键词采用//#开头 以：或者 : 结束；函数头注释以DOC.BEGIN开始, DOC.END结束。注释可以用注释精灵生成模板。
详细格式如下，
[B]我也不知道到底还缺少什么（是不是应该写上作者名字？），哪些是多余的，希望大家给点评价。[/B][/COLOR]

1. 
   
2. /////////////////////////////////////////////////////////////////////
   
3. //#  DOC.BEGIN
   
4. //#  函数名称：
   
5. //#  函数编号： 表征函数属类名，且反映函数版本：？OXA为全局函数
   
6. //              如 OXA00.03.01，前缀英文为类名，后四位数字对应函数加入
   
7. //              时的OXARX版本，即函数加入顺序，最后两位小数表示函数
   
8. //              被修改的次数。
   
9. //#  函数声明：bool oxaSetCurTextStyle(const char* lpStyleName,
   
10. //                                     AcDbDatabase* pDb)
    
11. //#  输入参数：解释参数意义，参数类型和约束范围，如
    
12. //            lpLayerName 修改的层名 char* [Layer]   Layer可识别关键词
    
13. //            nRepeatNumber 重复次数 int [0,100;150,200]
    
14. //#  输出参数：
    
15. //#  返回值：包括说明抛出的异常
    
16. //#  函数功能：
    
17. //#  函数分类：函数的类别和搜索的关键词等
    
18. //#  涉及的全局变量：
    
19. //#  调用的OXARX函数：这样可以跟踪函数调用，自动生成函数扇入扇出图
    
20. //#  函数算法： 包括重要变量的说明
    
21. //#  ACAD版本：可以使用的AutoCAD版本如R14  R15  R16
    
22. //#  配合函数：
    
23. //#  类似函数：
    
24. //#  替换函数：替换以前的老版本的函数或者类似功能的函数。
    
25. //#  现存缺陷：
    
26. //#  示例程序：
    
27. //#  测试要求：提出特殊测试要求和测试代码。
    
28. //#  历史记录：记录开始编程时间，结束时间，每次修改时间和修改内容。如
    
29. //             2003-8-13 完成。
    
30. //             2003-9-16 修改。。。。。。。
    
31. //  
    
32. //#  DOC.END
    
33. /////////////////////////////////////////////////////////////////////
    

复制代码

Echoyin

要不要注明函数调试通过的编译环境呢？如操作系统，编译工具等