规范介绍

产品项目规范主要包括：

• 组织规范：设计文档、目录命名、目录组织、文件命名、编译方法
• 代码规范：命名、缩进、可用语法、可选库
• 文档书写：介绍、安装说明、使用说明、API介绍

项目实现过程中主要包括项目名称、源代码、说明文档需要一个良好的书写规范，方便维护、阅读。在工作中需要养成良好的编码习惯。

项目创建

在创建一个全新的项目时需要明确基本目录结构，例如一个C项目目录结构，如下：

• xxx - 项目名称
  • docs - 存放设计文档、开发者文档
  • examples - 使用样例
  • include - 头文件
  • src - 源码文件
  • tests - 测试用例
  • Makefile - 构建工具（可选择automake、cmake书写）
  • README.md - 简单项目概述及使用说明
  • autogen.sh - 自动构建环境脚本

Python项目目录结构，如下：

• xxx - 项目名字
  • docs - 存放设计文档、开发者文档
  • examples - 使用样例
  • xxx - 项目源代码(同项目名字一致)
  • tests - 测试用例
  • README.md - 简单项目概述及使用说明
  • autogen.sh - 自动构建环境脚本
  • setup.cfg
  • setup.py - 打包分发，安装