引擎设置规范计划(一)

1：头文件中首先加载文件信息。

/*
*==================FreedomKnight引擎=====================
*
* Copyright (c) 2007.笃志

* All rights reserved.
* 
* 文件名称：filename.h
* 文件标识：见配置书
* 摘     要：本文件主要用于……
* 
* 当前版本：V1.0.0
* 作     者：笃志
* 完成日期：2007.03.21
*
*==================FreedomKnight引擎=====================
*/

2：任何函数，全局变量都必须在头文件进行声明，且不需定义。宏定义和调用库功能也在头文件实现。 头文件可以保证自己源代码不泄露，并可加强类型安全检查。

为防止头文件被引用，应加上ifndef/define/endif，例如


#ifndef STADAX_H
#define STADAX_H

#include <stdio.h>
#include "FkMyHead.h"

class FkNode
{
public:
   FkSecNode* g_pFkSecNode;    // 节点变量声明

private:
   void FkFun();    // 函数声明 
};

void Fun();

#endif

3:cpp源文件对函数进行实现。

先是依旧的版本版权声明。如头文件

#include "STADAX_H"

//==================================

// 类成员函数
void FkNode::FkFun()
{

}

//==================================

// 全局函数
void Fun()
{

}

//==================================

4:头文件和源文件应当分别保存，以方便维护.

  1. Code源目录
  • Include头文件目录
  • Source源文件目录
  • Inline内联文件目录
  1. Obj中间文件目录
  • Debug调试版本目录
  • Release发布版本目录
  1. Output输出目录
  • Debug调试版本目录
  • Release发布版本目录
  1. Other其他文件目录（资源文件，配置文件等）