Skip to content

github188/BasicFunctionCodeBase

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview
-------------------------------------------------

1、项目目录说明:

        ├───build       项目编译目录,各种编译的临时文件和最终的目标文件皆存于此,分为debug/和release/子目录
        │   ├───debug
        │   └───release
        ├───config      配置文件目录
        │   ├───scripts     保存一些构建脚本
        │   └───tools       项目支撑工具目录
        ├───dist        distribute分发目录,最终发布的可执行程序和各种运行支持文件存放在此目录,打包此目录即可完成项目分发
        │   ├───debug
        │   └───release
        ├───docs        保存项目各种文档,可以添加 wiki 文档;
        ├───src         源码目录,包括源代码、外部依赖库文件、所使用的资源文件     
        │   ├───include     公共头文件 + 外部依赖库头文件 目录,可以按模块划分组织目录来保存模块相关头文件
        │   │   ├───ffmpeg
        │   │   └───sdl
        │   ├───libs        外部依赖库目录
        │   ├───log
        │   ├───message
        │   ├───play_ui
        │   ├───resource    资源目录
        │   ├───stream_play
        │   └───utils       基本功能目录
        │       ├───base64
        │       ├───ini-parser
        │       └───json
        └───tests       测试用例或测试脚本目录


        
2、编程风格说明:








3、注释说明:

    TODO: + 说明:
        如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

    FIXME: + 说明:
        如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

    XXX: + 说明:
        如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。





    
        
   

About

基本功能代码库

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 48.2%
  • C 39.6%
  • Makefile 7.2%
  • Shell 2.4%
  • HTML 0.8%
  • CMake 0.8%
  • Other 1.0%