Комментирование и организация. Вы думали, что я скажу что-то вроде «.forEach», не так ли? Нет!
Позвольте мне рассказать вам кое-что о моем последнем проекте. Я, наконец, сделал это, я добрался до финального проекта. К счастью, я уже кое-что собрал с моим женихом. Изначально это была внутренняя шутка, в которой действительно было много хороших костей, чтобы превратить их в своего рода ежедневник после небольшой работы. Я запланировал встречу с моим инструктором и пошел на работу. Делал то и это, украшал страницу стилизованными JS-часами из codepen, которые выглядели великолепно, но в итоге я обманул себя, прежде чем очистить их, но это для другого блога.
За день до встречи я не спал до трех часов ночи, глядя на свой код блестящими глазами, на самом деле просто принимаясь за работу! Я был горд! Моя страница превратилась из странного, смущенного повтора в процветающее веб-приложение! С цветовыми схемами, функциональностью и в целом красивым звуковым кодом.
Если бы вы могли прочитать это.
Через несколько минут встречи с моим инструктором я уже раз пятнадцать сказал «э-э-э».
— Так как же работает эта часть? — спрашивал он.
«У-у-у, так что…» — говорил я, роясь колесиком мыши в едва сто пятидесяти строках кода, разбросанных поверх множества нечетко сформулированных переменных. Пытаясь найти тот цикл for, который я сделал во вторник в 1:43.
В любом случае, прежде чем я слишком сильно разоблачу себя, это был огромный урок, полученный в гордости и исправлении. Я просмотрел свой код сразу после нашей встречи и, прежде чем внести коррективы, которые должны были быть сделаны, я почистил его. Посмотрим правде в глаза, я бы все равно не смог внести эти коррективы без очистки.
Теперь я с гордостью практикую отступы и комментарии. Мне нравится, чтобы весь мой код был помечен функциональностью. Например, если я хочу создать случайное число, которое будет извлечено позже, я напишу что-то вроде этого.
//create random number
function getRandomInt(min, max) {
return parseInt(Math.random() * (max - min) + min);
}
Я уверен, что есть какой-то отраслевой стандарт, которого мне не хватает, но я учусь, и этот блог посвящен этому путешествию. Я отвлекся, лично я считаю, что наличие комментария в самой левой строке облегчает моим глазам захват названия/описания моей функции, не зацикливаясь на каком-либо реальном коде, и это даже не вызвало никаких проблем… так что далеко. Когда я пишу внутри функции, я делаю отступ для комментария вместе с кодом, так что…
//create random number
function pickRandomNum() {
//assign random number generator
let randomNum = getRandomInt(1, 3)
//show output
console.log(randomNum)
//check if random number is the best number
if (randomNum === 1) {
//reward! :)
console.log("good job!")
}
}
//call the function
pickRandomNum()
Я немного переборщил ради спора, но вы поняли. Таким образом, если я прокручиваю сотни строк кода или даже использую «ctrl+f» и ввожу ключевое слово, у меня есть что-то, что выделяется на английском языке, а не на языке JavaScript. В одном из двух у меня гораздо больше практики. Я рекомендую создать для себя какой-то гибкий метод организации, особенно пока мы учимся.
Как я уже сказал, я уверен, что для всего этого есть какой-то отраслевой стандарт, но пока я учусь, я хочу иметь возможность читать свой код. Мне просто нужно быть готовым приспосабливаться по мере роста.
