mirror of
https://gitee.com/tawords/tawords-docs
synced 2025-09-05 10:11:39 +08:00
small changes; add tavi system
This commit is contained in:
@@ -1,118 +0,0 @@
|
||||
#### 1.在有处理逻辑的代码中，源程序有效注释量必须在20％以上。
|
||||
> 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
|
||||
|
||||
#### 2.文件注释：文件注释写入文件头部。
|
||||
> 说明：以`/**`开始
|
||||
|
||||
示例：
|
||||
```php
|
||||
/**
|
||||
* 文件名：[文件名]
|
||||
* 作者：〈版权〉
|
||||
* 描述：〈描述〉
|
||||
* 修改人：〈修改人〉
|
||||
* 修改时间：YYYY-MM-DD
|
||||
* 修改内容：〈修改内容〉
|
||||
*/
|
||||
```
|
||||
> 说明：每次修改后在文件头部写明修改信息。
|
||||
|
||||
示例：
|
||||
```php
|
||||
/**
|
||||
* 文件名：LogManager.java
|
||||
* 版权：Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved.
|
||||
* 描述： WIN V200R002 WEBSMAP 通用日志系统
|
||||
* 修改人：张三
|
||||
* 修改时间：2001-02-16
|
||||
* 修改内容：新增
|
||||
* 修改人：李四
|
||||
* 修改时间：2001-02-26
|
||||
* 修改内容：。。。。。。
|
||||
* 修改人：王五
|
||||
* 修改时间：2001-03-25
|
||||
* 修改内容：。。。。。。
|
||||
*/
|
||||
```
|
||||
|
||||
#### 3.类和接口的注释：该注释放在 `class` 定义之前，`using` 或 `package` 关键字之后。
|
||||
示例：
|
||||
```php
|
||||
package com.websmap.comm;
|
||||
|
||||
/**
|
||||
* 注释内容
|
||||
*/
|
||||
public class CommManager
|
||||
```
|
||||
#### 4.类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。
|
||||
格式：
|
||||
```php
|
||||
/**
|
||||
* 〈一句话功能简述〉
|
||||
* 〈功能详细描述〉
|
||||
* @author [作者]
|
||||
* @version [版本号, YYYY-MM-DD]
|
||||
* @see [相关类/方法]
|
||||
* @since [产品/模块版本]
|
||||
* @deprecated
|
||||
*/
|
||||
```
|
||||
> 说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，`@since` 表示从那个版本开始就有这个类或者接口，`@deprecated` 表示不建议使用该类或者接口。
|
||||
|
||||
示例：
|
||||
```php
|
||||
/**
|
||||
* LogManager 类集中控制对日志读写的操作。
|
||||
* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，读取或写入符合条件的日志纪录。
|
||||
* @author 张三，李四，王五
|
||||
* @version 1.2, 2001-03-25
|
||||
* @see LogIteraotor
|
||||
* @see BasicLog
|
||||
* @since CommonLog1.0
|
||||
*/
|
||||
```
|
||||
|
||||
#### 5.类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。用 `// ` 来注释,需要对齐被注释代码。
|
||||
示例：
|
||||
```php
|
||||
// 注释内容
|
||||
private String logType
|
||||
```
|
||||
|
||||
#### 6.成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。用 `// ` 来注释，需要对齐被注释代码。
|
||||
|
||||
#### 7.公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
|
||||
格式：
|
||||
```php
|
||||
/**
|
||||
* 〈一句话功能简述〉
|
||||
* 〈功能详细描述〉
|
||||
* @param [参数1] [参数1说明]
|
||||
* @param [参数2] [参数2说明]
|
||||
* @return [返回类型说明]
|
||||
* @exception/throws [违例类型] [违例说明]
|
||||
* @see [类、类#方法、类#成员]
|
||||
* @deprecated
|
||||
*/
|
||||
```
|
||||
|
||||
> 说明：`@since` 表示从那个版本开始就有这个方法；`@exception`或 `throws` 列出可能出现的异常；`@deprecated` 表示不建议使用该方法。
|
||||
|
||||
#### 8.对于方法内部用 `throw` 语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非 `RuntimeException` ，即 `throws` 子句声明会抛出的异常，必须在方法的注释中标明。
|
||||
> 说明：异常注释用 `@exception`或 `@throws` 表示，在JavaDoc中两者等价，但推荐用 `@exception` 标注Runtime异常，`@throws` 标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。
|
||||
|
||||
#### 9.注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
|
||||
|
||||
#### 10.注释的排版，按照上述示例来展示。
|
||||
|
||||
#### 11.注释应该放在被注释的代码前面，分行展示，但中间不留空行。
|
||||
|
||||
#### 12.对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
|
||||
> 说明：分支语句往往是程序实现某一特定功能的关键。
|
||||
|
||||
#### 13.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
|
||||
|
||||
#### 14.注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。
|
||||
|
||||
#### 15.避免在注释中使用缩写，特别是不常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。
|
||||
@@ -1,2 +0,0 @@
|
||||
为避免重复及便于识别，应用名中不能出现特殊字符，应用识别名须遵循驼峰式书写规范，只能包含`大小写字母`和下划线`_`，应用目录名为应用识别名，定义的所有函数需要以应用识别名加`_`作为前缀；
|
||||
所有目录及文件名，全部小写，不得出现大写字母；
|
||||
@@ -1,3 +1,12 @@
|
||||
## 命名规范（待定）
|
||||
|
||||
为避免重复及便于识别，应用名中不能出现特殊字符，应用识别名须遵循驼峰式书写规范，只能包含`大小写字母`和下划线`_`，应用目录名为应用识别名，定义的所有函数需要以应用识别名加`_`作为前缀；
|
||||
所有目录及文件名，全部小写，不得出现大写字母；
|
||||
|
||||
|
||||
|
||||
## 注释规范 Annotation specification（待定）
|
||||
|
||||
> `@since` 表示从那个版本开始就有这个类/接口/方法
|
||||
> `@deprecated` 表示不建议使用该类/接口/方法
|
||||
> `@exception` 标注Runtime异常
|
||||
9
docs/manual/standard/logo-specification/name.md
Normal file
9
docs/manual/standard/logo-specification/name.md
Normal file
@@ -0,0 +1,9 @@
|
||||
## 名称规范 <!-- {docsify-ignore} -->
|
||||
|
||||
| 名称指代 | 中文 | 备注 | 英文 | 备注 |
|
||||
| -------------------------------------- | -------------------------- | ---------------------- | --------------------- | ------------------------------------------------------------ |
|
||||
| 项目的中（英）文名称<br />项目中的产品 | 背Ta单词 | 注意英文字母的大小写 | tawords | 一般全小写，与语法、命名规范等冲突时，可写为Tawords或TAWORDS |
|
||||
| 项目开发团队名称 | 背Ta团队、背Ta单词开发团队 | 注意不是“背Ta单词团队” | tawords team | 一般全小写，与语法、命名规范等冲突时，可写为Tawords Team或TAWORDS TEAM |
|
||||
| 项目中的产品标识 | 背Ta团队荣誉出品 | - | tawords team products | 一般全小写，与语法、命名规范等冲突时，可写为Tawords Team Products或TAWORDS TEAM PRODUCTS |
|
||||
| 代码中应用识别名 | - | - | bta | 一般全小写或全大写，例如 $bta , BTA_PATH , bta_user |
|
||||
|
||||
96
docs/manual/standard/logo-specification/tavi.md
Normal file
96
docs/manual/standard/logo-specification/tavi.md
Normal file
@@ -0,0 +1,96 @@
|
||||
## 视觉形象系统 <!-- {docsify-ignore} -->
|
||||
|
||||
为了体现出更好的视觉形象，更有利于视觉形象传播，同时更能展现出项目团队精神，特此研发**背Ta单词视觉形象识别系统**（**Tawords Visual Identity System**，简称“**TAVI**”）。
|
||||
|
||||
TAVI由背Ta团队负责人设计研发，分为基础板块（Ⅰ）和应用板块（Ⅱ）两大板块。以规范、实用为基本原则，对项目中使用到的及未来将可能使用到的各类相关标识进行整体设计，规范项目形象特征，完善标识使用规范。
|
||||
|
||||
> **基础板块**包括背Ta单词项目标志（LOGO）、标准字体、标准色彩、标志组合、辅助图形、禁用组合和专用字体。包含了基础设计要素及其规范使用形式。
|
||||
>
|
||||
> **应用板块**是基础部分在前端设计与项目宣传等方面使用示例。
|
||||
|
||||
TAVI适用于背Ta单词项目开发宣传中的各个环节，提供部分原图下载，欢迎大家在本视觉形象系统的约束下规范使用。
|
||||
|
||||
|
||||
|
||||
# （以下内容待完善） <!-- {docsify-ignore} -->
|
||||
|
||||
|
||||
# Ⅰ. 基础板块
|
||||
|
||||
## 项目标志（logo）
|
||||
|
||||
[logo](../../../include/tavi/backcolor ':include :type=iframe width=100% height=600px')
|
||||
|
||||
<nobr>
|
||||
|
||||
<style>
|
||||
.filletSample {
|
||||
width: 30px;
|
||||
height: 30px;
|
||||
}
|
||||
</style>
|
||||
|
||||
### 圆角
|
||||
|
||||
|
||||
| 圆角 | 圆角半径 ÷ ½边长<br />（百分比） | 示例 |
|
||||
| ------------------- | -------------------------------- | ------------------------------------------------------------ |
|
||||
| fillet0（圆形） | 0% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet0.png"> |
|
||||
| fillet1 | 11.1% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet1.png"> |
|
||||
| fillet2 | 33.3% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet2.png"> |
|
||||
| fillet3 | 55.2% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet3.png"> |
|
||||
| **fillet4（默认）** | **70.3%** | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet4.png"> |
|
||||
| fillet5 | 82.5% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet5.png"> |
|
||||
| fillet6（正方形） | 100% | <img class="assetsObject filletSample" objectPath="/v1/tavi/logo/sample/fillet/fillet6.png"> |
|
||||
|
||||
<style>
|
||||
.colorSample {
|
||||
width: 40px;
|
||||
height: 20px;
|
||||
display: inline-block;
|
||||
border: solid 1px black;
|
||||
vertical-align: middle;
|
||||
margin-top: 2px;
|
||||
margin-bottom: 2px;
|
||||
}
|
||||
</style>
|
||||
|
||||
|
||||
### 背景色
|
||||
|
||||
下列背景色为推荐颜色，推荐使用下列标准颜色码。
|
||||
|
||||
在下方颜色无法满足实际需求时，可以自定义背景色，但需要满足：①背景颜色不允许过浅或白色；②背景颜色不允许过亮过鲜艳。
|
||||
|
||||
| 颜色 | 示例 | 十六进制颜色码 | RGB颜色 |
|
||||
| ---------------------- | ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
|
||||
| **棕色（标准色）** | <div class="colorSample" style="background-color: #4f3730;"></div> | #4F3730 | (79, 55, 48) |
|
||||
| 黄色 | <div class="colorSample" style="background-color: #FFCF00;"></div> | #FFCF00 | (255, 207, 0) |
|
||||
| 紫色 | <div class="colorSample" style="background-color: #5F52A0;"></div> | #5F52A0 | (95, 82, 160) |
|
||||
| | <div class="colorSample" style="background-color: #8957A1;"></div> | #8957A1 | (137, 87, 161) |
|
||||
| 浅紫色 | <div class="colorSample" style="background-color: #8F82BC;"></div> | #8F82BC | (143, 130, 188) |
|
||||
| | <div class="colorSample" style="background-color: #8C97CB;"></div> | #8C97CB | (140, 151, 203) |
|
||||
| | <div class="colorSample" style="background-color: #88ABDA;"></div> | #88ABDA | (136, 171, 218) |
|
||||
| 蓝色 | <div class="colorSample" style="background-color: #556FB5;"></div> | #556FB5 | (85, 111, 181) |
|
||||
| | <div class="colorSample" style="background-color: #00B7EE;"></div> | #00B7EE | (0, 183, 238) |
|
||||
| 浅蓝色 | <div class="colorSample" style="background-color: #7ECEF4;"></div> | #7ECEF4 | (126, 206, 244) |
|
||||
| 粉色 | <div class="colorSample" style="background-color: #F19EC2;"></div> | #F19EC2 | (241, 158, 194) |
|
||||
| | <div class="colorSample" style="background-color: #F29C9F;"></div> | #F29C9F | (242, 156, 159) |
|
||||
| 青色 | <div class="colorSample" style="background-color: #84CCC9;"></div> | #84CCC9 | (132, 204, 201) |
|
||||
| 浅绿色 | <div class="colorSample" style="background-color: #89C997;"></div> | #89C997 | (137, 201, 151) |
|
||||
| 绿色 | <div class="colorSample" style="background-color: #32B16C;"></div> | #32B16C | (50, 177, 108) |
|
||||
| 橙色 | <div class="colorSample" style="background-color: #F8B551;"></div> | #F8B551 | (248, 181, 81) |
|
||||
| 橙红色 | <div class="colorSample" style="background-color: #EC6941;"></div> | #EC6941 | (236, 105, 65) |
|
||||
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | () |
|
||||
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | () |
|
||||
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | () |
|
||||
| | <div class="colorSample" style="background-color: #FFFFFF;"></div> | #FFFFFF | (, , ) |
|
||||
| 黑色 <br />👇<br />灰色 | <div class="colorSample" style="background-color: #000000;"></div> <div class="colorSample" style="background-color: #313131;"></div><br /><div class="colorSample" style="background-color: #434343;"></div> <div class="colorSample" style="background-color: #535353;"></div><br /><div class="colorSample" style="background-color: #626262;"></div> <div class="colorSample" style="background-color: #7D7D7D;"></div> | #000000 # #313131<br />#434343 #535353<br />#626262 #7D7D7D | (0, 0, 0) (49, 49, 49)<br />(67, 67, 67) (83, 83, 83)<br />(98, 98, 98) (125, 125, 125) |
|
||||
|
||||
</nobr>
|
||||
|
||||
|
||||
|
||||
|
||||
# Ⅱ. 应用板块
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
# 登录：
|
||||
## 注册、登录时密码使用的加密技术
|
||||
|
||||
### 登录
|
||||
|
||||
> 使用`密码加盐`生成不可逆哈希，**他人无法获取密码原文**。
|
||||
```javascript
|
||||
md5.hex(pwd + md5.hex(pwd));
|
||||
```
|
||||
|
||||
# 注册：
|
||||
### 注册
|
||||
> 使用密码倒序`Base64`加密，再倒序`Base64`加密，避免密码在网上裸奔。
|
||||
```javascript
|
||||
Base64.encode(Base64.encode(pwd.split('').reverse().join('')).split('').reverse().join(''));
|
||||
Reference in New Issue
Block a user