我的工程实践选题是《关于物联网组网方案的搜索引擎》,属于定向搜索引擎的一种,所以我在GitHub上下载了一个搜索引擎相关的源码进行分析。
- 结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点;
- 源代码目录结构
- 文件名/类名/函数名/变量名等命名规范
总体来说,命名采取小写字母+下划线的组合,但在名称上并不那么容易看懂。
每个函数之前会写明输入与功能,在接口格式上比较规范
- 列举哪些做法符合代码规范和风格一般要求;
- 函数前会写明功能,
- 命名函数/类时以英文功能名称来命名,方便阅读
- 注明了编码格式(使用UTF-8编码)
- 列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则,及如何进一步优化改进;
很多核心代码没有注释,不方便阅读与修改
- 总结同类编程语言或项目在代码规范和风格的一般要求。
1.命名应该以功能为主,格式要统一规范,方便阅读;
2.核心代码应有注释,方便后来人学习,改进;
3.使用UTF-8编码
4.类内方法空1行分隔,类外空2行分隔
5.1个前导下划线表示半公开,2个前导下划线表示私有,与保留字区分使用单个后置下划线