Sdscompany.ru

Компьютерный журнал
4 просмотров
Рейтинг статьи
1 звезда2 звезды3 звезды4 звезды5 звезд
Загрузка...

Javascript комментарии в коде

Комментарии

Как мы знаем из главы Структура кода, комментарии могут быть однострочными, начинающимися с // , и многострочными: /* . */ .

Обычно мы их используем, чтобы описать, как и почему работает код.

На первый взгляд, в комментариях нет ничего сложного, но новички в программировании часто применяют их неправильно.

Плохие комментарии

Новички склонны использовать комментарии, чтобы объяснять, «что делает код». Например, так:

Но в хорошем коде количество «объясняющих» комментариев должно быть минимальным. Серьёзно, код должен быть таким, чтобы его можно было понять без комментариев.

Про это есть хорошее правило: «Если код настолько запутанный, что требует комментариев, то, может быть, его стоит переделать?»

Рецепт: выносите код в функции

Иногда выгодно заменить часть кода функцией, например, в таком случае:

Лучший вариант – использовать отдельную функцию isPrime :

Теперь код легче понять. Функция сама становится комментарием. Такой код называется самодокументированным.

Рецепт: создавайте функции

И если мы имеем такой длинный кусок кода:

То будет лучше отрефакторить его с использованием функций:

Здесь комментарии тоже не нужны: функции сами говорят, что делают (если вы понимаете английский язык). И ещё, структура кода лучше, когда он разделён на части. Понятно, что делает каждая функция, что она принимает и что возвращает.

В реальности мы не можем полностью избежать «объясняющих» комментариев. Существуют сложные алгоритмы. И есть хитрые уловки для оптимизации. Но в целом мы должны стараться писать простой и самодокументированный код.

Хорошие комментарии

Итак, обычно «объясняющие» комментарии – это плохо. Но тогда какой комментарий считается хорошим?

Сделайте высокоуровневый обзор компонентов, того, как они взаимодействуют, каков поток управления в различных ситуациях… Если вкратце – обзор кода с высоты птичьего полёта. Существует специальный язык UML для создания диаграмм, разъясняющих архитектуру кода. Его определённо стоит изучить.

Документируйте параметры и использование функций

Есть специальный синтаксис JSDoc для документирования функций: использование, параметры, возвращаемое значение.

Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код.

Кстати, многие редакторы, такие как WebStorm, прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода.

Также существуют инструменты, например, JSDoc 3, которые умеют генерировать HTML-документацию из комментариев. Получить больше информации о JSDoc вы можете здесь: http://usejsdoc.org/.

Почему задача решена именно таким способом?

Важно то, что написано. Но то, что не написано, может быть даже более важным, чтобы понимать происходящее. Почему задача решена именно этим способом? Код не даёт ответа.

Если есть несколько способов решить задачу, то почему вы выбрали именно этот? Особенно если ваш способ – не самый очевидный.

Без подобных комментариев возможна следующая ситуация:

  1. Вы (или ваш коллега) открываете написанный некоторое время назад код и видите, что в нём есть, что улучшить.
  2. Вы думаете: «Каким глупым я раньше был и насколько умнее стал сейчас», и переписываете его на «более правильный и оптимальный» вариант.
  3. …Желание переписать код – это хорошо. Но в процессе вы понимаете, что «оптимальное» решение на самом деле не такое уж и оптимальное. Вы даже смутно припоминаете, почему, так как в прошлый раз вы уже его пробовали. Вы возвращаетесь к правильному варианту, потратив время зря.

Комментарии, объясняющие решение, очень важны. Они помогают продолжать разработку в правильном направлении.

В коде есть какие-то тонкости? Где они используются?

Если в коде есть какие-то тонкости и неочевидные вещи, его определённо нужно комментировать.

Итого

Комментарии – важный признак хорошего разработчика, причём как их наличие, так и отсутствие.

Хорошие комментарии позволяют нам поддерживать код, дают возможность вернуться к нему после перерыва и эффективнее его использовать.

Комментируйте:

  • Общую архитектуру, вид «с высоты птичьего полёта».
  • Использование функций.
  • Неочевидные решения, важные детали.

Избегайте комментариев:

  • Которые объясняют, как работает код, и что он делает.
  • Используйте их только в тех случаях, когда невозможно сделать настолько простой и самодокументированный код, что он не потребует комментариев.

Средства для генерации документации по коду, такие как JSDoc3, также используют комментарии: они их читают и генерируют HTML-документацию (или документацию в другом формате).

Предложение от 8host.com

Написание комментариев в JavaScript

В программировании обычно в первую очередь учитывается то, как компьютер читает и интерпретирует написанный код. Но так же важно учитывать интересы людей, которые будут читать и работать с этим кодом дальше. Нужно уметь правильно комментировать и структурировать свой код, чтобы обеспечить простоту чтения.

Комментарии – это пометки в исходном коде программы, которые не читаются интерпретатором и поэтому не влияют на фактический вывод кода. Комментарии могут быть чрезвычайно полезны для объяснения целей и действий того или иного блока кода.

Без комментариев разработчикам бывает сложно понять код, написанный другими людьми. Да и вы сами можете просто забыть, для чего добавили в программу тот или иной блок кода. Правильно прокомментированный код поможет вам избежать проблем с поддержкой программы в будущем.

Читать еще:  Java lang illegalstateexception already tesselating

Синтаксис комментариев

В JavaScript есть два типа комментариев.

Однострочные комментарии в JavaScript записываются с помощью двух слешей //.

// This is a comment

Интерпретатор будет игнорировать все символы после // до конца строки.

Многострочные комментарии заключаются в теги /* и */. Если вы знакомы с CSS, вы уже знаете, как работают такие комментарии.

/* This is
a comment */

Интерпретатор будет игнорировать все, что находится между этими тегами.

Все комментарии вне зависимости от их типа пишутся над блоком кода, который они объясняют.

// Print «Hello, World!» to the console
console.log(«Hello, World!»);

Кроме того, комментарии должны находиться на одном уровне с объясняемым кодом.

// Initialize a function
function alphabetizeOceans() <

// Define oceans variable as a list of strings
const oceans = [«Pacific», «Atlantic», «Indian», «Antarctic», «Arctic»];

// Print alphabetized array to the console
console.log(oceans.sort());

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

Встроенные комментарии

Если однострочный комментарий находится в конце строки кода, такой комментарий называется встроенным.

let x = 99; // assign numerical value to x
let y = x + 2; // assign the sum of x + 2 to y

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

Помните, что однострочные комментарии нельзя закрыть тегом. Если в эту строку случайно попадет код программы, интерпретатор пропустит его. Поэтому будьте внимательны, следите, чтобы комментарий не сливался со следующей строкой кода в одну строку.

for (let i = 0; i === 10; i++) // for loop that runs ten times <
// Running this code results in a syntax error
>

Встроенные комментарии бывают очень полезны, но их следует использовать экономно – код с большим количеством встроенных комментариев выглядит грязно и, следовательно, его трудно читать.

Многострочные комментарии

Многострочные комментарии пишутся на уровне блока и представляют собой длинные примечания или описание последующего блока кода. Часто этот тип комментариев размещается в верхней части файла или перед особенно сложным блоком кода.

/* Initialize and invoke a the greetUser function
to assign user’s name to a constant and print out
a greeting. */
function greetUser() <
const name = prompt(«What is your name?»);
console.log(«Hello ,» + name + «! How are you?»);
>
greetUser();

Иногда встречается немного видоизмененный синтаксис: комментарий открывается тегом /**, и каждая строка начинается с символа звездочки.

/**
* Initialize constant with an array of strings.
* Loop through each item in the array and print
* it to the console.
*/
const seaCreatures = [«Shark», «Fish», «Octopus»];
for (const seaCreature of seaCreatures) <
console.log(seaCreature);
>

Иногда эти комментарии также содержат сведения о файле программирования, включая имя, версию и автора сценария.

Комментирование кода для тестирования

Комментарии позволяют игнорировать те или иные блоки кода для тестирования работы программы. Это называется «закомментировать код».

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

// Function to add two numbers
function addTwoNumbers(x, y) <
let sum = x + y;
return sum;
>
// Function to multiply two numbers
function multiplyTwoNumbers(x, y) <
let product = x * y;
return product;
>
/* In this example, we’re commenting out the addTwoNumbers
function, therefore preventing it from executing. Only the
multiplyTwoNumbers function will run */
// addTwoNumbers(3, 5);
multiplyTwoNumbers(5, 9);

Закомментировать код можно с помощью как однострочных, так и многострочных комментариев. Выбор зависит от объема блока, который нужно закомментировать.

Примечание: Комментировать код нужно только на время тестирования. Не оставляйте закомментированные блоки в конечном сценарии.

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

Заключение

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

Comments

As we know from the chapter Code structure, comments can be single-line: starting with // and multiline: /* . */ .

We normally use them to describe how and why the code works.

At first sight, commenting might be obvious, but novices in programming often use them wrongly.

Bad comments

Novices tend to use comments to explain “what is going on in the code”. Like this:

But in good code, the amount of such “explanatory” comments should be minimal. Seriously, the code should be easy to understand without them.

There’s a great rule about that: “if the code is so unclear that it requires a comment, then maybe it should be rewritten instead”.

Recipe: factor out functions

Sometimes it’s beneficial to replace a code piece with a function, like here:

Читать еще:  Java control panel

The better variant, with a factored out function isPrime :

Now we can understand the code easily. The function itself becomes the comment. Such code is called self-descriptive.

Recipe: create functions

And if we have a long “code sheet” like this:

Then it might be a better variant to refactor it into functions like:

Once again, functions themselves tell what’s going on. There’s nothing to comment. And also the code structure is better when split. It’s clear what every function does, what it takes and what it returns.

In reality, we can’t totally avoid “explanatory” comments. There are complex algorithms. And there are smart “tweaks” for purposes of optimization. But generally we should try to keep the code simple and self-descriptive.

Good comments

So, explanatory comments are usually bad. Which comments are good?

Describe the architecture Provide a high-level overview of components, how they interact, what’s the control flow in various situations… In short – the bird’s eye view of the code. There’s a special language UML to build high-level architecture diagrams explaining the code. Definitely worth studying. Document function parameters and usage There’s a special syntax JSDoc to document a function: usage, parameters, returned value.

Such comments allow us to understand the purpose of the function and use it the right way without looking in its code.

By the way, many editors like WebStorm can understand them as well and use them to provide autocomplete and some automatic code-checking.

Also, there are tools like JSDoc 3 that can generate HTML-documentation from the comments. You can read more information about JSDoc at http://usejsdoc.org/.

Why is the task solved this way?

What’s written is important. But what’s not written may be even more important to understand what’s going on. Why is the task solved exactly this way? The code gives no answer.

If there are many ways to solve the task, why this one? Especially when it’s not the most obvious one.

Without such comments the following situation is possible:

  1. You (or your colleague) open the code written some time ago, and see that it’s “suboptimal”.
  2. You think: “How stupid I was then, and how much smarter I’m now”, and rewrite using the “more obvious and correct” variant.
  3. …The urge to rewrite was good. But in the process you see that the “more obvious” solution is actually lacking. You even dimly remember why, because you already tried it long ago. You revert to the correct variant, but the time was wasted.

Comments that explain the solution are very important. They help to continue development the right way.

Any subtle features of the code? Where they are used?

If the code has anything subtle and counter-intuitive, it’s definitely worth commenting.

Summary

An important sign of a good developer is comments: their presence and even their absence.

Good comments allow us to maintain the code well, come back to it after a delay and use it more effectively.

Comment this:

  • Overall architecture, high-level view.
  • Function usage.
  • Important solutions, especially when not immediately obvious.

Avoid comments:

  • That tell “how code works” and “what it does”.
  • Put them in only if it’s impossible to make the code so simple and self-descriptive that it doesn’t require them.

Comments are also used for auto-documenting tools like JSDoc3: they read them and generate HTML-docs (or docs in another format).

Почему этот код Javascript внутри браузера, отличного от Javascript, имеет дополнительные комментарии?

В учебнике W3 он показывает код htis:

Две косые черты в конце строки комментария ( / / ) — это JavaScript символ комментария. Это предотвращает выполнение JavaScript —> метка.

Это не имеет смысла для меня. Я думал, что все это было прокомментировано.

4 Ответов

В браузерах, которые понимают JavaScript открытие html комментарий игнорируется и выполняется код JS. Комментарий JS // в последней строке затем предотвращает закрытие —> , принимаемое за ошибку механизмом JS. В браузерах, которые не понимают JavaScript все между и —> берется как комментарий html и игнорируется.

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

Если вы хотите закомментировать блок JS, заключите его в /* и */ .

Прежде всего, W3Schools не имеет ничего общего с W3. Их учебники были довольно ужасными, прежде чем люди начали жаловаться, и их запутанное имя подразумевает, что они каким-то образом связаны с W3, но на самом деле это не так.

Во-вторых, этот метод больше не нужен. Нет никаких используемых браузеров, которые не поддерживают JS чисто ( links , lynx и т. д. не имеют никаких проблем с кодом JS вообще).

Это, как говорится, код должен сделать это:

Читать еще:  Интегрирование метод трапеций javascript

Если вы сделаете это так, вы получите синтаксическую ошибку:

JavaScript не знает, что комментарий HTML закрывает —> , поэтому он должен быть прокомментирован из сценария. Нет необходимости использовать HTML-комментарии для разделения JavaScript, за исключением случаев, когда вы используете простой текстовый редактор, который окрашивает код (NoteTab и т. д.).

Это все комментируется.

В боузере без Javascript все между будет закомментировано.

Попробуйте подумать об этом так: Если вы пробовали этот код

тогда Javascript выдаст ошибку.

Похожие вопросы:

Если у меня есть код javascript, который, например, выполняет некоторые действия по таймеру, и этот код встроен в веб-страницы на вкладке 1 и вкладке 2 веб-браузера, то может ли клиентский код.

У меня есть файл Flash, встроенный в HTML-объекты внутри расположены в зависимости от размера экрана браузера. Большую часть времени я не хочу полосу прокрутки, так как все правильно размещено, но.

Есть ли способ вызвать библиотеку c++ из кода javascript внутри браузера и node.js? В идеале, код для вызова функции в библиотеке одинаков для обоих случаев. Это приемлемо, если подход поддерживает.

У меня есть следующий объект: var obj = < 'ア' : 'testing', 'ダ' : '2015-5-15', 'ル' : 123, 'ト' : 'Good' >; Как получить доступ к значению с помощью ключа, отличного от ASCII (в данном случае это.

Я просто попробовал этот код в моем браузере (Chrome 39, Windows 8) :- .

Возможный Дубликат : Почему этот Javascript код внутри браузера, не являющегося Javascript, имеет дополнительные комментарии? Иногда я вижу некоторые Javascript, которые начинаются с

Javascript комментарии в коде

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

JavaScript поддерживает два вида комментариев: однострочный и многострочный. Всё, что идёт после символов // (два слэша) и до конца строки считается комментарием, такой вид комментария называется «однострочным». Любой текст между символами /* и */ считается комментарием, такой вид комментария называется «многострочным», так как он может состоять из нескольких строк:

Комментарии используют для пояснения каких-нибудь участков кода.

Ещё одна важная роль комментариев, которую часто используют на практике – это временное отключение некоторой части кода. Таким образом комментарии используют, когда бывает трудно определить местонахождение ошибки или, когда некоторая часть кода временно не нужна.

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

Комментарии используются для пояснения JavaScript кода, чтобы сделать его более понятным.

Также, комментарии позволяют закрыть отдельные участки JavaScript кода от выполнения во время тестирования альтернативных алгоритмов.

Однострочные комментарии

Чтобы определить однострочный комментарии, необходимо перед текстом комментария написать двойной прямой слэш (//). Любой текст между двойным слэшем (//) и концом строки будет игнорироваться (не будет выполняться) обработчиком JavaScript.

В следующем примере перед каждой строкой кода определяется однострочный комментарий:

В следующем примере одностроччный комментарий используется в конце каждой строки для пояснения JavaScript кода:

Многострочные комментарии

Для определения многострочного комментария используется конструкция /*. */. Любой текст, находящийся между /* и */ будет игнорироваться обработчиком JavaScript.

В следующем примере используется многострочный комментарий (блок комментария) для пояснения JavaScript кода:

Как правило, чаще используют однострочные комментарии. Блоки комментариев обычно используются для официальной документации.

Использование комментариев, чтобы закрыть код от выполнения

Для того чтобы протестировать работу скрипта, очень удобно закрывать определенные участки кода при помощи комментариев, проверяя различные альтернативы.

Добавление слэшей // перед строкой кода сделает его неисполняемым и превратит в комментарий.

В следующем примере слэши // используются, чтобы закрыть от выполнения одну из строк кода:

В следующем примере блок комментариев используется, чтобы закрыть от выполнения сразу несколько строк кода:

Какие существуют комментарии в JavaScript

В языке JavaScript существуют два вида комментариев:
— однострочные // и
— многострочные /* */

Комментарии JavaScript располагают внутри кода JavaScript, между тегами или в файле .js

Однострочный комментарий

Однострочный комментарий, начинается с двойного слэша // и действует на всю строку, после слэша.

Пример использования однострочнного комментария (комментарии выделены красным цветом) :

Многострочный комментарий

Многострочный комментарий начинается с символов /* и заканчивается символами */

Многострочный комментарий может располагаться на одной строке или на нескольких. Интерпретатор JavaScript, пропускает символы /* */ и не обрабатывает их, как и то, что расположено между ними.

Пример использования многострочнного комментария:

Для чего используются комментарии в JavaScript

Использование комментариев в языке JavaScript, необходимо в двух случаях:

  1. Для описания сложной программы, когда вы записываете что делает та или иная часть данного кода, потом вернувшыись к нему через некоторое время, вы сможете вспомнить, что делали и почему
  2. Для отладки программы, например комментариями можно закрывать тот или иной участок кода и в итоге выяснить откуда начинается возникновение ошибки в коде JavaScript
Ссылка на основную публикацию
ВсеИнструменты 220 Вольт
Adblock
detector