文章技术规范
happytaohaha
好记性不如烂笔头
展开
-
Java开发手册-4.安全规约
安全规约【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。 说明:防止没有做水平权限校验就可随意访问、修改、删除别人的数据,比如查看他人的私信 内容、修改他人的订单。【强制】用户敏感数据禁止直接展示,必须对展示数据进行脱敏。 说明:中国大陆个人手机号码显示为:158****9119,隐藏中间 4 位,防止隐私泄露。【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADAT...转载 2019-10-17 10:32:09 · 397 阅读 · 0 评论 -
Java开发手册-3.单元测试
三、单元测试【强制】好的单元测试必须遵守 AIR 原则。说明:单元测试在线上运行时,感觉像空气(AIR)一样并不存在,但在测试质量的保障上, 却是非常关键的。好的单元测试宏观上来说,具有自动化、独立性、可重复执行的特点。A:Automatic(自动化)I:Independent(独立性)R:Repeatable(可重复)【强制】单元测试应该是全自动执行的,并且非交互式的。测试...转载 2019-10-17 10:28:33 · 329 阅读 · 0 评论 -
Java开发手册-2.异常日志
idea、eclipse 插件安装:https://yq.aliyun.com/articles/224817?spm=a2c4e.11153940.0.0.5b7bf72fqJS0Fs二、异常日志1.异常处理【强制】Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理,比如:NullPointerException,I...转载 2019-10-15 16:55:15 · 360 阅读 · 1 评论 -
Java开发手册-1.编程规约
编程规约(一) 命名风格【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例:name / name / $name / name / name$ / name【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用。正例:aliba...转载 2019-10-15 16:33:34 · 338 阅读 · 0 评论 -
中文技术文档的规范-文档体系
文档体系结构软件手册是一部完整的书,建议采用下面的结构。简介(Introduction): [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明快速上手(Getting Started):[可选] [文件] 如何最快速地使用产品入门篇(Basics): [必备] [目录] 又称”使用篇“,提供初级的使用教程– 环境准备(Prerequisite):[必备] [文件] 软件...转载 2019-10-09 16:59:41 · 373 阅读 · 0 评论 -
中文技术文档的规范-标点符号
标点符号原则(1)中文语句的标点符号,均应该采取全角符号,这样可以与全角文字保持视觉的一致。(2)如果整句为英文,则该句使用英文/半角标点。(3)句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。句号(1)中文语句的结尾处应该用全角句号(。)。(2)句子末尾用括号加注时,句号应在括号之外。错误:关于文件的输出,请参照第 1.3 节(见第 26 页。)正确:关于文...转载 2019-10-09 16:54:00 · 2809 阅读 · 0 评论 -
中文技术文档的规范-数值
数值半角数字阿拉伯数字一律使用半角形式,不得使用全角形式。错误: 这件商品的价格是1000元。正确: 这件商品的价格是 1000 元。千分号数值为千位以上,应添加千分号(半角逗号)。XXX 公司的实收资本为 ¥1,258,000 人民币。对于 4 位以下的数值,千分号是选用的,比如1000和1,000都可以接受。对于 4 位以上的数值,千分号是必须的。货币货币应为...转载 2019-10-09 16:44:21 · 853 阅读 · 0 评论 -
中文技术文档的规范-段落
段落原则一个段落只能有一个主题,或一个中心句子。段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子为核心句服务。一个段落的长度不能超过七行,最佳段落长度小于等于四行。段落的句子语气要使用陈述和肯定语气,避免使用感叹语气。段落之间使用一个空行隔开。段落开头不要留出空白字符。引用引用第三方内容时,应注明出处。One man’s constant is anothe...转载 2019-10-09 16:31:45 · 567 阅读 · 0 评论 -
中文技术文档的规范-文本
文本字间距(1)全角中文字符与半角英文字符之间,应有一个半角空格。错误:本文介绍如何快速启动Windows系统。正确:本文介绍如何快速启动 Windows 系统。(2)全角中文字符与半角阿拉伯数字之间,有没有半角空格都可,但必须保证风格统一,不能两种风格混杂。正确:2011年5月15日,我订购了5台笔记本电脑与10台平板电脑。正确:2011 年 5 月 15 日,我订购了 ...转载 2019-10-09 16:29:43 · 381 阅读 · 0 评论 -
中文技术文档的规范-标题
标题层级标题分为四个层级一级标题:文章的标题二级标题:文章主要部分的大标题三级标题:二级标题下面一级的小标题四级标题:三级标题下面某一方面的小标题下面是示例# 一级标题## 二级标题### 三级标题#### 四级标题原则(1)一级标题下,不能直接出现三级标题。示例:下面的文章结构,缺少二级标题。# 一级标题### 三级标题(2)标题要避免孤立...转载 2019-10-08 11:26:46 · 1075 阅读 · 0 评论