Heim  >  Artikel  >  Web-Frontend  >  So gestalten Sie Ihren JS-Code besser aussehend und leichter lesbar_Grundkenntnisse

So gestalten Sie Ihren JS-Code besser aussehend und leichter lesbar_Grundkenntnisse

韦小宝
韦小宝Original
2017-12-04 13:53:441286Durchsuche

Dieser Artikel stellt den meisten JS-Programmierern vor allem vor, wie sie den von ihnen geschriebenen JS-Code schön und leicht lesbar machen können. Außerdem werden verschiedene Stellen und Methoden analysiert, die Aufmerksamkeit erfordern. Wenn Sie gerade erst anfangen JS, sollten Studierende einen Blick darauf werfen und gemeinsam lernen.

Wenn der Code, den Sie als JS-Programmierer schreiben, gut aussieht und leicht zu lesen ist, wird er nicht nur für Sie gut aussehen, sondern auch die Übergabe reibungsloser gestalten, wenn ein anderer Programmierer übernimmt.

Lassen Sie keine großen Abschnitte des kommentierten Codes im Code

Überlassen Sie die Verwaltung Git, sonst warum sollten Sie Git wollen?


// bad

// function add() {
//  const a = b + c
//  return a
// }

function add() {
 return a + 1000
}

// good
function add() {
 return a + 1000
}


Zeilen entsprechend umbrechen


// bad
function a() {
 const {
  state_a,
  state_b,
  state_c
 } = this.state
 this.setState({state_a: state_a * 2})
 return 'done'
}

// good
function a() {
 const {
  state_a,
  state_b,
  state_c
 } = this.state

 this.setState({state_a: state_a * 2})

 return 'done'
}


Fügen Sie Kommentare angemessen hinzu, aber fügen Sie keine Kommentare wie verrückt hinzu

Kommentieren Sie einen Codeabschnitt oder eine Codezeile, die besondere Aufmerksamkeit erfordert

Don' Ich mache keine verrückten Kommentare, es ist zu ausführlich und schön. Der Code kann für sich selbst sprechen


// bad
const a = 'a' // 这是a
const b = 'b' // 这是b
const c = 'c' // 这是c

// good
/**
 * 申明变量
 */
 const a = 'a'
 const b = 'b'
 const c = 'c'


Kategoriecodes mit ähnlichen Verhaltensweisen und Namen zusammen


// bad
function handleClick(arr) {
 const a = 1

 arr.map(e => e + a)

 const b = 2

 return arr.length + b
}

// good
function handleClick(arr) {
 const a = 1
 const b = 2

 arr.map(e => e + a)

 return arr.length + b
}


Ohne die Semantik zu zerstören, „speichere, was du kannst, speichere“

Behalte Bedenken Sie, dass eine Funktion in js auf Bürger wartet

Wenn sie jedoch so weit weggelassen wird, dass die Lesbarkeit beeinträchtigt wird, ist sie ein Fehler

Wenn Sie Wählen Sie zwischen Lesbarkeit und Einfachheit. Wählen Sie immer zuerst Lesbarkeit


function add(a) {
 return a + 1
}

function doSomething() {

}

// bad
arr.map(a => {
 return add(a)
})

setTimeout(() => {
 doSomething()
}, 1000)

// good
arr.map(add)

setTimeout(doSomething, 1000)


Pfeilfunktionen


// bad
const a = (v) => {
 return v + 1
}

// good
const a = v => v + 1


// bad
const b = (v, i) => {
 return {
  v,
  i
 }
}

// good
const b = (v, i) => ({v, i})


// bad
const c = () => {
 return (dispatch) => {
  // doSomething
 }
}

// good
const c = () => dispatch => {
 // doSomething
}


Ermitteln Sie den Wert des Objekts im Voraus (Schüler, die schreiben, müssen reagieren, müssen verstehen)


// bad
const a = this.props.prop_a + this.props.prop_b

this.props.fun()

// good
const {
 prop_a,
 prop_b,
 fun
} = this.props

const a = prop_a + prop_b

fun()


Vernünftige Verwendung verschiedener Ausdrücke


// bad
if (cb) {
 cb()
}

// good
cb && cb()


// bad
if (a) {
 return b
} else {
 return c
}

// good
return a ? b : c


// bad
if (a) {
 c = a
} else {
 c = 'default'
}

// good
c = a || 'default'


Methode zum Schreiben von Kettenaufrufen


// bad
fetch(url).then(res => {
 return res.json()
}).then(() => {
 // doSomething
}).catch(e => {

})

// good
fetch(url)
 .then(res => {
  return res.json()
 })
 .then(() => {
  // doSomething
 })
 .catch(e => {

 })


Halten Sie den Code vertikal

Suchen Sie diejenigen, die in der gesamten Datei besonders hervorstechen. Wenn Sie den Code eingeben, sollten Sie erwägen, sie umzubrechen


// bad
return handleClick(type, key, ref, self, source, props)

// good
return handleClick(
 type,
 key,
 ref,
 self,
 source,
 props
)

// bad
const a = this.props.prop_a === &#39;hello&#39; ? <di>world</p> : null

// good
const a = this.props.prop_a === &#39;hello&#39;
 ? <di>world</p>
 : null


Das Obige ist der gesamte Inhalt dieses Artikels, ich hoffe, er wird für Studenten hilfreich sein, die gerade erst mit js beginnen.

Verwandte Empfehlungen:

Web-Front-End-Codespezifikationen

JavaScript-Code-Spezifikationen und Leistungsveredelung

Javascript-Code-Spezifikationen Zusammenfassung der PHP-Code-Spezifikationen

Das obige ist der detaillierte Inhalt vonSo gestalten Sie Ihren JS-Code besser aussehend und leichter lesbar_Grundkenntnisse. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn