Parcourir la source

#IQRV #comment [DevAdapter]更新适配器编写说明

gifur il y a 4 ans
Parent
commit
3cf02d910a
1 fichiers modifiés avec 34 ajouts et 4 suppressions
  1. 34 4
      DevAdapter/Readme.md

+ 34 - 4
DevAdapter/Readme.md

@@ -1,8 +1,8 @@
 # 信创版本厂商源码编写事项
 
-**版本**:V1.0.0
+**版本**:V1.0.1
 
-**最后更新日期**:2020年12月8日19点39
+**最后更新日期**:2021年1月13日15点33
 
 ## 首要说明
 
@@ -159,14 +159,44 @@ link_directories(${VENDOR_CURRENT_LIB_DIR})
 
 其他注意事项请看模板内相关 CMakeLists.txt 的注释内容和编码规范文档
 
+
+
+## 代码编写
+
+### 头文件引用
+
+上面提到,在招行的编译环境中,会把厂商的头文件目录(如:DevAdapter/cmbsz/include)放置在其他独立开来,所以在**编码时不要使用相对路径!!**。我行提供的CMake宏`rvc_dev_config_library`已经将·**DevAdapter/include**·和`**DevAdapter/{当前厂商名称}/include**`加入到头文件的搜索路径中,所以在编码时,只要所需引用的头文件在这两个文件夹中,直接引用头文件名称即可,无需再单独加相对路径,**否则有可能会出现找不到头文件而报错的风险**。例如:
+
+在某个厂商适配器实现中
+
+```c++
+#include "../include/DRV_IDCardReader.h"
+#include "../../include/IDCerClass.h"
+#include "../include/CILIX_AUX_UTILS.h"
+#include "../include/log4vendor.h"
+```
+
+需要改成:
+
+```
+#include "DRV_IDCardReader.h"
+#include "IDCerClass.h"
+#include "CILIX_AUX_UTILS.h"
+#include "log4vendor.h"
+```
+
+## 请勿将我行公用头文件拷贝到适配器目录内引用
+
+我行提供的库文件,一般都会放置在**DevAdapter/include**目录中,包括适配器头文件、日志库头文件等,不要将这些头文件拷贝到厂商目录(如:DevAdapter/cmbsz)下的任意目录中(如:DevAdapter/cmbsz/include),避免后续我行在更新公共文件时出现引用错误导致编译报错。
+
 ## 提交要求
 
 1. 仅需提供厂商文件夹,无需提供整个DevAdapter文件夹
 
-2. 提供的厂商文件夹以厂商名称命名,而不是我行提供的Demo名称”cmbsz"
+2. 提供的厂商文件夹以厂商名称命名,而不是我行提供的Demo名称”cmbsz"!!
 
 3. 提供的内容注意去掉无关文件:生成的日志文件、CMake构建残留文件、有源码的适配器库生成文件或依赖库文件、我行提供的Demo(空文件夹也不允许,没用就删掉)
 
-4. 【新】厂商文件夹首层目录提供**CHANGELOG**文件,该文件需要记录几个重要元素:版本变更记录,提交日期,版本号等
+4. **建议:**厂商文件夹首层目录提供**CHANGELOG**文件,该文件需要记录几个重要元素:版本变更记录,提交日期,版本号等。并合适地将对应的版本号同步填充到适配器接口GetDevCategory返回的相关字段中。