首页   组合类型列表   文件列表   组合类型成员   相关页面  

cc_example.h

浏览该文件的文档。
00001 /**
00002  * 使用 C++ 语言开发的范例:头文件
00003  * 
00004  */
00005 
00006 #include <string>
00007 
00008 //! 这是一个类的说明注释的样子,这里是简要说明
00009 /**
00010  * 这是一个类的说明的详细解释。
00011  *
00012  * 类的命名是一个很重要的问题,一定要仔细考虑好,如果你想不出
00013  * 一个合适的名字,去和其他人讨论这个问题。
00014  *
00015  * 下面的样子可以写一个居中的数学公式:
00016  *
00017  * \f[
00018  *   -\Delta u = f, \qquad \mathrm{in\ } \Omega
00019  * \f]
00020  *
00021  * 这是一个行中间的数学公式的写法 \f$ \left. u \right|_{\partial
00022  * \Omega} = u_b \f$。
00023  *
00024  * 如果算法中用到了一些参考文献,请在这里详细的列出来:
00025  *
00026  * <b>auther name</b>, <i>paper title</i>, journal infomation
00027  *
00028  * 我们在这里可以使用 HTML 的命令,文档处理工具会认识这些命令的。
00029  *
00030  * 我们在这里引用了一下 \ref cc_example 作为参考。
00031  * 
00032  */
00033 class ClassName
00034 {
00035 private:
00036   int                        m_member_var; /**< 这是一个成员变量的注释 */
00037   double                     epsilon;      /**< 使用希腊字母命名不要有拼写错误 */
00038   FEMFunction                u_h;          /**
00039                                             * 这是另外一种成员变量注释的写法
00040                                             *
00041                                             * 命名和数学表达式中尽量一致
00042                                             * 同时考虑匈牙利命名规则
00043                                             *
00044                                             */
00045 public:
00046   /**
00047    * 一个没有参变量的函数
00048    * 
00049    */
00050   void exFunNoArg();
00051   /** 
00052    * 这是一个有参数和返回值的函数的例子
00053    * 
00054    * @param arg1 第一个参数的说明
00055    * @param arg2 第二个参数的说明
00056    * 
00057    * @return 返回值的说明
00058    */
00059   double exFunWithArg(const int& arg1,
00060                       const std::string& arg2);
00061 };
00062 
00063 /**
00064  * end of file
00065  * 
00066  */
00067 

Generated at Fri Sep 17 10:55:37 2004 for 使用 C++ 进行开发的范例 by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002