C++基本工程规范
工程创建
环境: VS 2017
1、建立解决方案,可采用全英文小写命名
2、项目采用驼峰命名法,项目可以创建多个,但都需要采用全英文,且不能重复和产生歧义
3、源文件必须分为至少一个头文件和一个.cpp文件 ,在头文件中#include所有需要支持库文件,创建
一个命名空间(命名空间名无特定要求与),创建一个类, 如果需要生成.dll 需要添加__declspec(dllexport) ,可以使内部对外接口封闭。
4、在头文件中, 同时需要注明Public : Private : public 中需要声明调用者能直接使用的方法(禁止将调用者用不上的方法声明在Public 中),其他的依赖函数声明应放在private 中,保持对内封闭
- 方法在声明时需要 做好注释
基本注释包括:
/**
* @description: 找符合连通判定距离的所有矩形横切中线
* @param: 第一个多边形顶点点集{start, end}; 第二个多边形顶点点集{start, end}; 连通判定距离d
* @return: 满足连通的条件下,所有连通矩形的横切中线
* @author:chenyichuan
*/
vector <pair<osg::Vec3f, osg::Vec3f>> arrangeSolver(vector<osg::Vec3f> polygon0, vector<osg::Vec3f> polygon1, float d);
- .cpp源文件的所有函数 需要从头文件函数构造,每个函数指明命名空间以及类名
void adSolver::WallConnect::showPolyEdges(int n1, int n2, vector <pair<osg::Vec3f, osg::Vec3f>> polyOneEdges, vector <pair<osg::Vec3f, osg::Vec3f>> polyTwoEdges)