# 技术文档规范 文档采用 Markdown 语法书写。...简介（Introduction） - [必选][目录 | 文件] 提供对产品和文档本身的总体的、扼要的说明 入门篇（Quickstart） - [可选][文件] 如何最快速地使用产品 基础篇（Basics...文件名 文档的文件名不得含有空格。 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。...Emoji 在 markdown 文档中，普遍会使用 emoji，帮助理解内容。但是，如果滥用 emoji，可能会适得其反。
前言 前端规范主要是为了让代码能有更好的可读性以及优雅性。不要为了规范而去规范，使用某些花里胡哨的写法，本质上是为了代码的维护性更强一些，所以才会制定规范来约束。...~ 推荐-Vue-Router写法 推荐-Vue项目目录结构 推荐-Vue实例选项顺序 推荐-优雅引用字体 推荐-200错误统一处理 前后端分离接口规范 前端工程工具链 前端Git规范 前端JS规范...前端CSS规范 1....，在 API 变化时更新接口文档 后端根据接口文档进行接口开发 前端根据接口文档进行开发 + Mock平台 开发完成后联调和提交测试 Mock 服务器根据接口文档自动生成 Mock 数据，实现接口文档即...前端CSS规范 前端CSS规范 分号 每个属性声明后面都要加分号。
编码规范 一、 HTML编码规范 1.代码风格 1.1 缩进与换行 [强制] 使用4个空格作为一个缩进层级。 [建议] 每行不得超过120个字符。...[建议] 常用的选择器命名 1代码风格 1.1 缩进 [强制] 统一使用 4 个空格缩进，不得使用 tab 和 2 个空格（没规范前的缩进方式不管）。...1.7.3 文档化注释 [强制] 为了便于代码阅读和自文档化，以下内容必须包含 /**…*/ 形式的块注释中。 解释： 文件 2.namespace 3. 类 4....AMD 模块 [强制] 文档注释前必须空一行。 [建议] 自文档化身为文档说明what，而不是how。 1.7.4类型定义 [强制] 类型定义都是以 { 开始，以 } 结束。...解释： 没有 @lends 标记将无法为该类生成包含拓展类成员的文档。
使用不带BOM的UTF-8编码 在HTML中指定编码<meta charset="utf-8">; 无需使用@charset指定样式表编码，它默认为UTF-...
四、语言属性 根据 HTML5 规范： 强烈建议为 html 根元素指定 lang 属性，从而为文档设置正确的语言。...这样做的好处是，可以避免在 HTML 中使用字符实体标记（character entity），从而全部与文档编码一致（一般采用 UTF-8 编码）。 ?...在扫描文档时，小写字符易于分辨，因为他们的形式更易于区分。 （12）尽量使用简写形式的十六进制值，例如，用 #fff 代替 #ffffff。...不要将他们打包放在一个单一样式文件中或者放在文档底部。如果你把他们分开了，将来只会被大家遗忘。 4.2 Example ?...（2）制定一致的注释规范。 （3）使用一致的空白符将代码分隔成块，这样利于扫描较大的文档。 （4）如果使用了多个 CSS 文件，将其按照组件而非页面的形式分拆，因为页面会被重组，而组件只会被移动。
腾讯alloyteam团队前端代码规范：https://www.kancloud.cn/digest/code-guide/42604
HEAD apple-touch-icon 图片自动处理成圆角和高光等效果; apple-touch-icon-precomposed 禁止系统自动添加效果，直接显示设计原图; 文档类型 <!...========================================================================= */ 由于定位（positioning）可以从正常的文档流中移除元素...var loadingData = ajax.get('url'); loadingData.then(callback); 接口命名规范 (1.可读性强 2.不与jQuery社区习惯冲突 3.尽量写全不用缩写...{"extends": "eslint-config-airbnb"} 参考 ES6入门-编程风格 前端开发规范手册 网页字体排印指南 ----
时等于 false, 否则是 true if ([0] && []) { // true // 数组(即使是空数组)也是对象，对象等于true } 分号 Standard 的规范是不使用分号的
基本原则 结构、样式、行为分离 尽量确保文档和模板只包含 HTML 结构，样式都放到样式表里，行为都放到脚本里。...HEAD 文档类型 为每个 HTML 页面的第一行添加标准模式（standard mode）的声明， 这样能够确保在每个浏览器中拥有一致的表现。 <!...最大缩放比例； 此手册是在开发中积累下来的经验和参考其它规范
文档规范 HTML5的文档类型声明： DOCTYPE标签是一种标准通用标记语言的文档类型声明，它的目的是要告诉标准通用标记语言解析器，它应该使用什么样的文档类型定义（DTD）来解析文档。...'valid' : 'invalid' ---- JSHint 在js规范中，有很多规范都是样式上的规范而不是逻辑上的规范，比如尽量使用=== 而不是==，我们可以使用JSHint或者JSLint，Javascript...其余规范参考官方文档：http://jshint.com/docs/ 名称 含义 curly 循环或者条件语句必须使用花括号包住 eqeqeq 使用强制等=== newcap 对于首字母大写的函数（声明的类...---- 使用子选择器 很多前端开发人员写选择器链的时候不使用 直接子选择器（注：直接子选择器和后代选择器的区别）。 有时，这可能会导致疼痛的设计问题并且有时候可能会很耗性能。
发布版本-需求标题 文档变更记录 日期 版本号 修订内容 修订人 目 录 [TOC] XXX功能详细设计 【 详细设计文档针对一个具体功能或者模块进行详细设计， 完成设计文档后...注意修改页文档版本控制。
html规范 实用为王,减少标签的数量 尽量遵循 HTML 标准和语义，但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度。 <!...来人为干预图片显示的尺寸，而且建议 标签中不要带上width 和height 两个属性，这是因为制作过程中，图片往往需要反复的修改，这样可以避免人为干预图片显示的尺寸，尽可能的发挥浏览器自身的功能； css规范...在扫描文档时，小写字符易于分辨，因为他们的形式更易于区分。 尽量使用简写形式的十六进制值，例如，用 #fff 代替 #ffffff。...Positioning （定位） Box model （盒模型） Typographic （排版） Visual （视觉） 由于定位（positioning）可以从正常的文档流中移除元素...一、语言规范 语句的结尾总是使用分号 【强制】语句的结尾总是使用分号 var foo = bar; // semicolon here. var foo = function() { return
代码规范和文档编写 Golang 的代码规范和文档编写指南 Golang 是一种高性能、并发性强的编程语言，越来越受到开发者们的喜爱。...但是，为了保证代码的可读性、可维护性和可扩展性，我们需要遵循一些编码规范和文档编写规范。本篇文章将介绍 Golang 的代码规范和文档编写指南。 1....Golang 的代码规范 1.1 代码格式化 在 Golang 中，代码格式化非常重要。我们可以使用 go fmt 命令来格式化代码。...Golang 的文档工具可以自动运行并测试示例代码，以确保它们是正确的。 3. 结论 以上就是 Golang 的代码规范和文档编写指南。...遵循这些规范可以使代码更易于维护和扩展，并且可以提高开发效率和代码质量。同时，使用 godoc 工具和编写示例代码可以帮助其他人了解你的代码和使用方式。
(二)HTML 规范 （Vue Template 同样适用） 1.2.1 HTML 类型 推荐使用 HTML5 的文档类型声明。建议使用 text/html 格式的 HTML，避免使用 XHTML。...2)很多前端开发人员写选择器链的时候不使用 直接子选择器（注：直接子选择器和后代选择器的区别）。有时，这可能会导致疼痛的设计问题并且有时候可能会很耗性能。然而，在任何情况下，这是一个非常不好的做法。...比如权限：后端 privilege，前端无论是 router、store、api 等都必须使用 privilege 单词！...每个 API 方法都应添加注释，注释与后端的 Swagger 文档保持一致。...正例： 后端 URL：EmployeeController.java /employee/add /employee/delete/{id} /employee/update 前端：employee.js
声明顺序相关属性应为一组，推荐的样式编写顺序 Positioning Box model Typographic Visual 由于定位（positioning）可以从正常的文档流中移除元素
下面这几点将工作中所踩的一些坑简单整理了一下,团队几个人开发,一些默契就比较重要,可以提高开发效率和代码的可读性
var loadingData = ajax.get('url'); loadingData.then(callback); 接口命名规范 可读性强，见名晓义； 尽量不与 jQuery 社区已有的习惯冲突
来源：待你如初 https://segmentfault.com/a/1190000037657222 前言 随着互联网高速的发展，信息安全已经成为企业重点关注焦点之一，而前端又是引发安全问题的高危据点...，所以，作为一个前端开发人员，需要了解前端的安全问题，以及如何去预防、修复安全漏洞。...下面就以前端可能受到的攻击方式为起点，讲解web中可能存在的安全漏洞以及如何去检测这些安全漏洞，如何去防范潜在的恶意攻击。 ---- 1....那么既然反射型XSS也可以是HTML注入，那么它注入的关键自然也就从前端的HTML页面开始下手： 1....参考文献 十大常见web漏洞及防范 hyddd CSRF攻击与防御 浅谈前端安全 前端安全
【前端工程化】配置 React+ts 企业级代码规范及样式格式和 git 提交规范 git 提交规范 ?husky:可以监听?githooks 执行，在对应hook执行阶段做一些处理的操作。 ?...commitizen：git的规范化提交工具，辅助填写commit信息。 可以看我这篇文章：?【前端工程化】配置 React+ts 企业级代码规范及样式格式和 git 提交规范 # 三....【前端工程化】从入门到精通，100 行代码构建你的前端 CLI 脚手架之路 # 十四. git 操作规范 git操作规范也很重要，流程不规范很容易出现比较复杂的问题，要根据公司现有情况和业界比较好的实践方案制定一套适合自己公司的...规范和使用文档输出文档站点 代码规范和 git 提交规范以及各个封装的库使用说明要输出成文档部署到线上，方便新同事快速熟悉和使用。...这个是很重要的，做了再多的基建和规范，如果没有一个公共的文文档来查阅，就没办法快速熟悉，所以要一个线上的规范文档，把所有的规范都写进去，可以用语雀
总结一下目前在用的前端代码规范，可作为开发参考 一、基础规范 开发规范 项目目录和文件的命名使用小写字母，避免使用大写或驼峰，多个单词以下划线 _ 分隔 如：my_project/cast_detail.js...BEM规范 三、注释规范 好的注释不仅能够表达”是什么“，还能表达”为什么“ HTML注释规范 注释以字符 Smarty 前端模板注释规范 注释以字符 结束 当只是作为代码意义标识的时候，统一使用HTML的注释规则 <!...注释以字符 /* 开始，以字符 */ 结束，至少三行，参考以下例子 建议在难以理解的代码块，逻辑性强，特殊处理的地方使用 /* * one space after '*' */ var x = 1; 文档注释...JSDoc规范 JSDoc用于根据规范的JS注释自动生成对应的API文档，如果不需要生成文档，只需遵循以下常用规范 注释前要空一行，建议在所有函数，类，常量中使用 常用的几个标签：@author @
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
