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

ClassName类参考

这是一个类的说明注释的样子,这里是简要说明. 更多...

#include <cc_example.h>

所有成员的列表。

公有成员

void exFunNoArg ()
double exFunWithArg (const int &arg1, const std::string &arg2)

私有属性

int m_member_var
double epsilon
FEMFunction u_h


详细描述

这是一个类的说明的详细解释。

类的命名是一个很重要的问题,一定要仔细考虑好,如果你想不出 一个合适的名字,去和其他人讨论这个问题。

下面的样子可以写一个居中的数学公式:

这是一个行中间的数学公式的写法

如果算法中用到了一些参考文献,请在这里详细的列出来:

auther name, paper title, journal infomation

我们在这里可以使用 HTML 的命令,文档处理工具会认识这些命令的。

我们在这里引用了一下 使用 C++ 进行开发的范例:程序外的文档 作为参考。

在文件cc_example.h32行定义。


成员函数文档

void ClassName::exFunNoArg  
 

一个没有参变量的函数

在文件cc_example.cpp15行定义。

double ClassName::exFunWithArg const int &    arg1,
const std::string &    arg2
 

这是一个有参数和返回值的函数的例子

参数:
arg1  第一个参数的说明
arg2  第二个参数的说明
返回:
返回值的说明


成员数据文档

double ClassName::epsilon [private]
 

使用希腊字母命名不要有拼写错误

在文件cc_example.h36行定义。

int ClassName::m_member_var [private]
 

这是一个成员变量的注释

在文件cc_example.h35行定义。

FEMFunction ClassName::u_h [private]
 

在文件cc_example.h37行定义。


该类的文档由以下文件生成:
Generated at Fri Sep 17 10:55:37 2004 for 使用 C++ 进行开发的范例 by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002