原文链接 https://tinyslik.github.io/2017/01/20/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83/
注：以下为加速网络访问所做的原文缓存，经过重新格式化，可能存在格式方面的问题，或偶有遗漏信息，请以原文为准。
vni
<!-- more -->
/*****************************************************************************
* Vni Basic tool library *
* Copyright (C) 2017 Vless Inc *
* *
* This file is part of Vni. *
* *
* it used to learn how to write code. *
* *
* @file Example.h *
* @brief 对文件的简述 *
* Details. *
* *
* @author Tiny.Slik *
* @email tinysilk@hotamil.com *
* @version 1.0.0.1(文件最后修改适应的版本号) *
* *
*----------------------------------------------------------------------------*
* Remark : Description *
*----------------------------------------------------------------------------*
* Change History : *
* <Date> | <Version> | <Author> | <Description> *
*----------------------------------------------------------------------------*
* 2017/01/20 | 1.0.0.1 | Tiny.Wu | Create file *
*----------------------------------------------------------------------------*
* *
*****************************************************************************/
//---------------------------------------------------------------------------
// myName
//---------------------------------------------------------------------------
#define STAND_NAME "tiny"
//---------------------------------------------------------------------------
// myGlobalValue
//---------------------------------------------------------------------------
long g_globalValue;
//---------------------------------------------------------------------------
// myStaticNum
//---------------------------------------------------------------------------
static int s_num;
//---------------------------------------------------------------------------
// Platform Defines
//---------------------------------------------------------------------------
enum
{
OST_PLATFORM_WIN32 = 1,
OST_PLATFORM_LINUX_X86 = 2,
OST_PLATFORM_LINUX_ARM = 3,
OST_PLATFORM_ANDROID = 4,
OST_PLATFORM_MACOSX = 5,
};
/**
* @brief Vni Project NameSpace \n
* vni project
*/
namespace Vni
{
}
/**
* @brief 简要说明文字
*/
typedef struct 结构体名字
{
a1, /*!< 简要说明文字 */
a2, /*!< 简要说明文字 */
a3, /*!< 简要说明文字 */
}StructAbc；
/**
* @brief 类的简单概述 \n(换行)
* 类的详细概述
*/
class MyClass
{
public:
//函数功能过于简单或无说明必要时，注释段省写。
MyClass(){};
~MyClass()();
/**
* @brief 函数简要说明-测试函数
* @param index 参数1
* @param t 参数2 @see CTest
*
* @return 返回说明
* -<em>false</em> fail
* -<em>true</em> succeed
*/
bool test(int index, const CTest& t);
/**
* @brief 打开文件 \n
* 文件打开成功后，必须使用::CloseFile函数关闭
* @param[in] fileName 文件名
* @param[in] fileMode 文件模式，可以由以下几个模块组合而成：
* -r读取
* -w 可写
* -a 添加
* -t 文本模式(不能与b联用)
* -b 二进制模式(不能与t联用)
* @return 返回文件编号
* --1表示打开文件失败(生成时:.-1)
* @note文件打开成功后，必须使用::CloseFile函数关闭
* @par 示例:
* @code
* //用文本只读方式打开文件
* int ret = OpenFile("test.txt", "a");
* @endcode
* @see 函数::ReadFile::CloseFile (“::”是指定有连接功能,可以看文档里的CloseFile变成绿,点击它可以跳转到CloseFile.)
* @deprecated由于特殊的原因，这个函数可能会在将来的版本中取消
*/
int openFile(const char* fileName, const char* fileMode);
/**
* @brief 关闭文件
* @param [in] file 文件
*
* @retval 0 成功
* @retval -1 失败
* @pre file 必须使用OpenFile的返回值
*/
int closeFile(int file);
//简单使用时
/**
* @brief funcGetThings
* get some fun;
*/
void funcGetThings();
/**
* @brief funcGetThings
* put little apple
*/
void funcPUtThings();
private:
/**
* @brief funcGetThings
* test some func;
*/
int funcTestThings();
/**
* @brief 成员变量m_abc简要说明
*
* 成员变量m_abc的详细说明，这里可以对变量进行
* 详细的说明和描述，具体方法和函数的标注是一样的
*/
char m_abc;
unsigned char m_uAbc；
}