Вы все еще пишете этот покалывающий код?

внешний интерфейс спецификация кода

Командные проекты, хорошие привычки кодирования очень важны.Ниже приведены привычки кода в моем проекте разработки, которые могут быть вам полезны.

WHY?

  • Командный проект — это не один человек, который пишет код, это круто писать код самому, но и позволять другим видеть его наглядно
  • Сократите обработку ошибок, облегчите поиск и устранение ошибок, повысьте эффективность разработки и сократите ненужное потребление энергии.
  • Удобно для постобслуживания

HOW?

Основные рекомендации

  • Отступ кода строго равномерный или и то, и другое2пробелы, или оба4Пробелы, все пробелы запрещено использовать взаимозаменяемо, что приводит к смещению кода и к головной боли.
  • Подавление разрывов кода (лишние пустые строки в полных блоках кода)
  • Заметки должны быть написаны
  • В неинженерных проектахcssзапрещено вhtmlнаписано в коде
  • Выйти бесполезный код будет удален
  • Удобный для разработки код, такой какconsole.log()илиalert()Удалено после завершения разработки

HTML

  • писать заметки

Если объем кода небольшой, вы все равно можете видеть четко, но если объем кода большой, не так просто прочитать много кода без комментариев, поэтому комментарии должны быть написаны

<!-- yes -->
<!-- 下一步 -->
<div class="btn-group df-jcc">
  <button class="next-step cp">下一步</button>
  <button class="submit cp">提交</button>
  <button class="exit cp">退出</button>
</div>

<!-- 提示 -->
<div class="prompt-layer">
  <div class="title df-aic df-jcc">
    <h3>温馨提示</h3>
  </div>
  <div class="prompt-content">
    <img src="xxx.png" alt="xxx">
    <p class="ac"></p>
  </div>
</div>


<!-- no -->
<div class="btn-group df-jcc">
  <button class="next-step cp">下一步</button>
  <button class="submit cp">提交</button>
  <button class="exit cp">退出</button>
</div>
<div class="prompt-layer">
  <div class="title df-aic df-jcc">
    <h3>温馨提示</h3>
  </div>
  <div class="prompt-content">
    <img src="xxx.png" alt="xxx">
    <p class="ac"></p>
  </div>
</div>
  • Этикетка «Добросовестное использование»
<!-- 头部 -->
<header></header>
<!-- 主内容 -->
<main></main>
<!-- 尾部 -->
<footer></footer>
<!-- 按钮 -->
<button></button>
<!-- 导航 -->
<nav></nav>
<!-- 标题 h1-h6 -->
<h3></h3>

......

<!-- yes -->
<button class="btn"></button>

<!-- no -->
<div class="btn"></div>
  • Этикеткаclassилиidсемантика именования

голова:class="header"

хвостик:footer

навигация:nav

Боковая панель:sidebar

Страница закладок:tab

меню:menu

......

<!-- yes -->
<div class="sidebar"></div>

<!-- no -->
<div class="left"></div>
  • Использование значения атрибута тега""пакет, не использовать''
<!-- yes -->
<footer class="footer"></footer>

<!-- no -->
<footer class='footer'></footer>
  • Порядок написания атрибута метки

class

id

data-*

src, type, href, value

title, alt

<!-- yes -->
<a class="" id="" data-val="" href=""></a>

<!-- no -->
<a id="" href="" class="" data-val=""></a>
  • Нарушение кода запрещено, лишние пустые строки ухудшают читаемость кода
<!-- yes -->
<div class="point-type df bg-white mb-20 p-20-30 border-e5">
  <div class="text-title">
    <h3></h3>
  </div>
  <nav class="flex-1">
    <ul class="clearfix"></ul>
  </nav>
</div>

<!-- very poor -->
<div class="point-type df bg-white mb-20 p-20-30 border-e5">

  <div class="text-title">
  
    <h3></h3>
  </div>
  
  <nav class="flex-1">
    <ul class="clearfix"></ul>
    
  </nav>
</div>

CSS

  • Стиль инициализации проектаreset.css
*{-webkit-box-sizing: content-box; -moz-box-sizing: content-box; box-sizing: content-box;}
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { margin:0; padding:0;}
body { color:rgba(51,51,51,0.8); font-size:14px; font-family: "Arial","Microsoft YaHei","黑体","宋体",sans-serif; }
td,th,caption { font-size:14px; }
h1, h2, h3, h4, h5, h6 { font-weight:normal; font-size:100%; }
address, caption, cite, code, dfn, em, strong, th, var { font-style:normal; font-weight:normal;}
a { color:#555; text-decoration:none; }
a:hover { text-decoration: none; }
img { border:none; vertical-align: middle}
ol,ul,li { list-style:none; }
i{font-style: normal;}
input, textarea, select, button { font:14px "Arial","Microsoft YaHei","黑体","宋体",sans-serif;}
input,button{border: none; outline: none;}
input[type=checkbox], input[type=radio]{margin: 0;}
table { border-collapse:collapse; }
html {overflow-y: scroll;}
p{margin: 0;}
.clearfix:after {content: "."; display: block; height:0; clear:both; visibility: hidden;}
.clearfix { *zoom:1; }/*公共类*/
  • Пользовательские общедоступные стили проекта равномерно размещаются в указанномcssсередина(По своим привычкам, вот что я написалcssПривычка)
  1. Соберите несколько часто используемых стилей в одном местеpublic.cssдокумент, избегайте повторяющихся записей
/* 
 * public.css
 */
 
.fl {
    float: left;
}
.fr {
    float: right;
}
.ac {
    text-align: center;
}
.ar {
    text-align: right;
}
.df {
    display: -webkit-flex;
    display: flex;
}
.df-aic {
    display: -webkit-flex;
    display: flex;
    align-items: center;
}
.df-jcc {
    display: -webkit-flex;
    display: flex;
    justify-content: center;
}
.flex-1 {
    flex: 1;
}
.bs {
    -webkit-box-sizing: border-box;
    -moz-box-sizing: border-box;
    box-sizing: border-box;
}
.cp {
    cursor: pointer;
}
.bg-white {
    background-color: #fff;
}
.w100 {
    width: 100%;
}
.h100 {
    height: 100%;
}
.mb-20 {
    margin-bottom: 20px;
}

......
  1. Другие общие стили помещены в единыйbase.cssсередина
/* 
 * base.css
 * 凡是多个页面会同时使用到的样式全部放入该文件中 
 */
 
body {
    background-color: #f9f9fb;
}
.container {
    width: 1280px;
    margin: auto;
    padding: 0 15px;
}

/* 头部 */
header {}

/* 主内容 */
main {}

/* 尾部 */
footer {}

/* 搜索 */
.search {}

/* checkbox */
input[type="checkbox"] {
    width: 20px;
    height: 20px;
    -webkit-appearance:none;
    background: url("xxx.png") no-repeat center;
}
input[type="checkbox"]:checked {
    background: url("xxx.png") no-repeat center;
}

......
  • писать заметки

Пишите комментарии к стилю блока кода, напримерheader,footer,列表,搜索,返回顶部 ...

/* yes */
/* header */
header {}

/* footer */
footer {}

/* 返回顶部 */
.go-top {}

/* no */
header {}
footer {}
.go-top {}
  • cssпорядок написания
  1. стиль положения текстаfloat，position，left，top，display，z-index...
  2. ширина и высота текста, поляwidth，height，padding，margin...
  3. Цвет текста, размерcolor，line-height，font-size，text-align...
  4. фон текста, границаbackground，border...
  5. разноеborder-radius，transform，transiton... 
/* yes */
nav ul li {
    float: left;
    width: 90px;
    height: 32px;
    margin: 10px;
    padding: 0 20px 0 10px;
    font-size: 18px;
    text-align: right;
    border: 1px solid #eee;
    border-radius: 4px;
}

/* no */
nav ul li {
    margin: 10px;
    text-align: right;
    border: 1px solid #eee;
    width: 90px;
    height: 32px;
    padding: 0 20px 0 10px;
    float: left;
    font-size: 18px;
    border-radius: 4px;
}
  • padding marginнаписание
/* 只有一个值的情况 */
.title {
    margin-left: 10px;
}

/* 多值情况 */
/* yes */
.title {
    margin: 0 20px 10px;
}

/* no */
.title {
    margin-top: 0;
    margin-right: 20px;
    margin-left: 20px;
    margin-bottom: 10px;
}
  • cssОставьте пробел с каждой стороны селектора
/* yes */
label + input {
    margin-left: 10px;
}
nav > ul > li {
    margin-left: 10px;
}

/* no */
label+input {
    margin-left: 10px;
}
nav>ul>li {
    margin-left: 10px;
}

JavaScript

  • писать заметки

  1. комментарий ко всему функциональному модулю

    /**
 *   列表筛选
 *   @param {Array} xxxxx              保存所选省份
 *   @param {String} xxxxxxxxxx        保存所选年代
 *   @method xxxx                      保存所选部分，用于筛选
 *   @method xxxx                      删除筛选中所选条件
 * 	 ......
 */

  2. Небольшие комментарии функционального кода внутри всего функционального модуля также должны быть написаны.

    // 列表分页
xxxx

// 重置筛选条件
xxxx
  • CamelCase
/* yes */
let searchVal = '';
function getUserInfo() {}

/* no */
let searchval = '';
function getuserinfo() {}
......
  • Добавление пробелов делает код более элегантным

  1. = == === > < % + * / , ...

    /* yes */
const name = 'yuci';
const userArr = ['a', 'b', 'c'];
if (i === 0) {
    // do
}
for (let i = 0, len = arr.length; i < len; i++) {
    // do
}

/* no */
const name='yuci';
const userArr=['a','b','c'];
if(i===0){
    // do
}
for(let i=0,len=arr.length;i<len;i++){
    // do
}
......

  2. if else for while switch try catch function ...

    /* yes */
if (i === 0) {
    // do
} else {
    // do
}
try {
    // do
} catch {
    // do
}
switch (dataSort) {
    // do
}
for (let i = 0, len = arr.length; i < len; i++) {
    // do
}
const fn = username => {
    // do
}
function fn() {
    // do
}

/* no */
if(i===0){
    // do
}else{
    // do
}
for(let i=0,len=arr.length;i<len;i++){
    // do
}
switch(dataSort){
    // do
}
const fn=username=>{
    // do
}
function fn(){
    // do
}
......

  3. объект:добавить пробел справа

    /* yes */
const user = {
    name: 'xxx',
    age: 'xxx'
}
this.state = {
    username: ''
}
this.setState({
    username: 'yucihent'
})

/* no */
const user = {
    name:'xxx',
    age:'xxx'
}
......
  • Разрывы кода запрещены (очень плохо читаются)
/* yes */
/**
 * fetch请求封装
 */
let fetchData = async (url, method, data) => {
    let options;
    let dataStr = '';
    const headers = {
      'Accept': 'application/json',
      'Content-Type': 'application/x-www-form-urlencoded'
    };
    // get 请求
    if (method === 'get') {
        if (typeof data === 'object') {
            Object.keys(data).forEach(key => {
                dataStr += `${key}=${data[key]}&`
            });
            if (dataStr) {
                dataStr = dataStr.substring(0, dataStr.length - 1)
            };
            url = `${url}?${dataStr}`;
        }
        options = {
            method: 'GET',
            headers,
        }
    } else {
        let formData = new FormData();
        for (let key in data) {
            formData.append(key, data[key])
        }
        options = {
            method: 'POST',
            body: formData
        }
    }
    let response = await fetch(url, options);
    let res = await response.json();
    return res;
}

/* very poor very poor very poor */
let fetchData = async (url, method, data) => {
    let options;
    let dataStr = '';
    const headers = {
      'Accept': 'application/json',
      'Content-Type': 'application/x-www-form-urlencoded'
    };
    // get 请求
    if (method === 'get') {
        if (typeof data === 'object') {
            Object.keys(data).forEach(key => {
                dataStr += `${key}=${data[key]}&`
            });
            
            if (dataStr) {
                dataStr = dataStr.substring(0, dataStr.length - 1)
                
            };
            url = `${url}?${dataStr}`;

        }
        options = {
            method: 'GET',
            headers,
        }
    } else {
        let formData = new FormData();
        
        for (let key in data) {
            formData.append(key, data[key])
            
        }
        options = {
            method: 'POST',
            body: formData
        }


    }
    
    let response = await fetch(url, options);
    let res = await response.json();
    return res;


}
  • Не используйте слишком много строк кода
/* yes */
import {
    List,
    InputItem,
    WingBlank,
    WhiteSpace,
    Button,
    Radio,
    Toast
} from 'antd-mobile'

/* no */
import { List, InputItem, WingBlank, WhiteSpace, Button, Radio, Toast } from 'antd-mobile'
  • использовать'', вместо""
/* yes */
import HelloWorld from './components/HelloWorld'
methods: {
    delItem(index) {
    	this.$emit('delItem', index)
    }
}

/* no */
import HelloWorld from "./components/HelloWorld"
methods: {
    delItem(index) {
    	this.$emit("delItem", index)
    }
}
  • лаконично и ясно

  1. замена строки шаблона++Конкатенация строк

  2. присваивание деструктуризации

    /* yes */
this.state = {
    name: 'xxx',
    age: 'xxx'
}
const { name, age } = this.state;

/* no */
const name = this.state.name;
const age = this.state.age;

  3. имя свойства значение свойства такое же сокращение

    /* yes */
components: {
    Header,
    Footer
}

/* no */
components: {
    Header: Header,
    Footer: Footer
}

  4. функция

    /* yes */
methods: {
    delItem(index) {
    	this.$emit('delItem', index)
    }
}

/* no */
methods: {
    delItem: function(index) {
    	this.$emit('delItem', index)
    }
}

    ......

заключительные замечания

Вышеупомянутое содержание является частичным резюме проблем со спецификацией кода, с которыми я столкнулся в проекте, и моих привычек кодирования. Это невозможно применить к каждому разработчику, но большинство стилей кодирования должны соответствовать вкусу публики. Я надеюсь, что это может помочь каждому.

нытье

Золотое правило командной работы:Другие смотрят на ваш код так же, как и на ваш собственный., хорошие привычки кодированияочень важно очень важно очень важно

Категории