节选自“Discuz! 开放平台的编码规范”(通用的)
http://open.discuz.net/?ac=document&page=dev_coderule
本文字体字号大小(只针对本文编辑器):
项目描述 字号 加重与否 例
重要内容标题 18pt 重色 I. 代码编写规范,“序”
一般描述性文字 13px 不加重色 序的内容
一般描述性文字标题 13px 重色 副标题“代码标记”
(注:行与行间间隔,保持一致,列头保持一致;每行内容长度控制在屏宽的2/3左右)
序:
每种开发语言的编码规范都是不同的,但有的又是相通的。不管是你是做 php(开发)或者 java,又或者 android / ios。
编码规范度,是一个码农经验的体现。编码规范的重要性,自然不言而喻。
下面看看这篇文章中,我们可以借鉴哪些编码上的想通的约定。
当然,限于篇幅,编码规范是一项系统的工程,本篇只是抛砖引玉,还有哪些优秀的编码习惯你也可以在评论中补充。
本篇中讲到的编码规范方向:
代码编写;数据库设计;其他方面
(注:本篇只是对原文内容的整理,限于一些细则方面,不再赘述.)
I. 代码编写规范
1. 代码标记
2. 注释
3. 书写规范
4. 命名规范
5. 变量/逻辑检查
6. 安全性
7. 兼容性
8. 代码重用
9. 其他细节
II.数据库设计规范
1. 表结构
2. 字段
3. 性能
III.其他方面
1. 跨平台
2. 项目目录命名
3. 文件在项目位置引用
【推荐】还在用 ECharts 开发大屏?试试这款永久免费的开源 BI 工具!
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 对象命名为何需要避免'-er'和'-or'后缀
· SQL Server如何跟踪自动统计信息更新?
· AI与.NET技术实操系列:使用Catalyst进行自然语言处理
· 分享一个我遇到过的“量子力学”级别的BUG。
· Linux系列:如何调试 malloc 的底层源码
· C# 中比较实用的关键字,基础高频面试题!
· .NET 10 Preview 2 增强了 Blazor 和.NET MAUI
· Ollama系列05:Ollama API 使用指南
· 为什么AI教师难以实现
· 如何让低于1B参数的小型语言模型实现 100% 的准确率