Javascript-форум (https://javascript.ru/forum/)
-   Оффтопик (https://javascript.ru/forum/offtopic/)
-   -   Комментарии по ссылке (https://javascript.ru/forum/offtopic/56077-kommentarii-po-ssylke.html)

Gozar 28.05.2015 18:41

Комментарии по ссылке
 
1. Идея наверное не нова, но поделюсь, может кому будет интересно. В коде ставим метку, например (слова разные можно):
//*attantion


, а ниже в нужно месте пишем:
//см. *attantion

В простом коде подобное не нужно, но если проект большой, то может сильно облегчить жизнь.

Если кто-то ещё знает улучшители разбора понимания логики, то напишите.

2. Если кто не в курсе в Web(Php)Strom есть вкладка TODO. Очень полезная штука. Удобная навигация по всему проекту.

kobezzza 29.05.2015 09:12

В JSDoc для этих задач есть @see, WS поддерживает.

Gozar 29.05.2015 12:16

Цитата:

Сообщение от kobezzza
В JSDoc для этих задач есть @see, WS поддерживает.

Несовсем.

@see ссылается на переменную или на функцию, по ней можно ткнуть и попадешь в декларацию.

А если мне нужно сослаться на другую строку комментария расположенного ниже или выше или и там и там, то @see мне уже ничем не поможет.

Gozar 29.05.2015 12:18

Цитата:

Сообщение от kobezzza
WS поддерживает

А вот это не важно, т.к. иногда нужно просмотреть не в веб сторм и там это уже не работает в большинстве случаев.

kobezzza 29.05.2015 14:01

Цитата:

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

Gozar 29.05.2015 17:16

Цитата:

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

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

/*description
 * тут подробное описание логики, никаких функций, методов и т.д. просто текст
 */

// см. *description <- тут создаем ссылку на описанный выше/ниже блок


Как реализовать подобное в jsDoc?


Часовой пояс GMT +3, время: 14:00.