Skip to content

Commit

Permalink
更新说明。
Browse files Browse the repository at this point in the history
  • Loading branch information
kouzhudong committed Jan 28, 2024
1 parent cd1a477 commit cc738b5
Showing 1 changed file with 20 additions and 24 deletions.
44 changes: 20 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,35 +31,31 @@ windows network library
---

本库的设计的几个规则:
1.尽量不调用日志函数。
刚开始的时候还考虑是否使用日志,以及何种日志。
2.因为上一条,所以代码失败要返回详细的信息,也就是失败的原因。
3.因为上两条的原因,所以使用者要检查返回值,并记录日志。
4.代码不会主动抛异常。代码尽量屏蔽异常。但是不代表代码中没有异常。
代码尽量捕捉异常并返回信息。
5.导出(对外公开的)的函数都是NTAPI调用格式。
6.代码尽量使用SAL(source-code annotation language:源代码批注语言)。
7.代码格式类似go和python.
8.代码尽量不使用硬编码。
9.代码开启静态的语法检查(启用Microsoft Code Analysis, 关闭Clang-Tidy)。
10.警告的等级是4级,且将警告视为错误。
11.代码的运行要过:驱动程序校验器/应用程序校验器/gflags.exe.
12.禁止使用断言(估计现在代码中还有不少断言)。
13.接口的参数只有基本类型和指针(没有类,模板和引用)。
14.只依赖操作系统的库,不再依赖第三方的库(特指动态库),当然crt,wil不可免。
15.所有接口皆为C接口,即EXTERN_C。
16.C语言标准选择:ISO C17 (2018)标准 (/std:c17)。
17.C++语言标准选择:ISO C++17 标准 (/std:c++17) 或者:预览 - 最新 C++ 工作草案中的功能 (/std:c++latest)。
1. 尽量不调用日志函数。
刚开始的时候还考虑是否使用日志,以及何种日志。
2. 因为上一条,所以代码失败要返回详细的信息,也就是失败的原因。
3. 因为上两条的原因,所以使用者要检查返回值,并记录日志。
4. 代码不会主动抛异常。代码尽量屏蔽异常。但是不代表代码中没有异常。
代码尽量捕捉异常并返回信息。
5. 导出(对外公开的)的函数都是NTAPI调用格式。
6. 代码尽量使用SAL(source-code annotation language:源代码批注语言)。
7. 代码格式类似go和python.
8. 代码尽量不使用硬编码。
9. 代码开启静态的语法检查(启用Microsoft Code Analysis, 关闭Clang-Tidy)。
10. 警告的等级是4级,且将警告视为错误。
11. 代码的运行要过:驱动程序校验器/应用程序校验器/gflags.exe.
12. 禁止使用断言(估计现在代码中还有不少断言)。
13. 接口的参数只有基本类型和指针(没有类,模板和引用)。
14. 只依赖操作系统的库,不再依赖第三方的库(特指动态库),当然crt,wil不可免。
15. 所有接口皆为C接口,即EXTERN_C。
16. C语言标准选择:ISO C17 (2018)标准 (/std:c17)。
17. C++语言标准选择:ISO C++17 标准 (/std:c++17) 或者:预览 - 最新 C++ 工作草案中的功能 (/std:c++latest)。

特别说明:
本库只提供c/c++/rust调用接口文档,
其他的,如:ASM,C#,GO,PYTHON,JAVA,PHP等自行定义。

注意:
1.接口或者回调的调用方式。__stdcall or __cdecl or __fastcall。
2.解决方案的默认调试程序是DLL,而不是EXE。
且这个是保存在数据库里,而不是配置文件里。
所以在调试时,做好设置默认的启动程序为EXE。
注意:接口或者回调的调用方式。__stdcall or __cdecl or __fastcall。

---

Expand Down

0 comments on commit cc738b5

Please sign in to comment.