Имя: Пароль:
JOB
Работа
Почему разработчики типовых ТАК пишут комментарии?
,
0 Планета Обезьян
 
24.08.11
09:12
почти все комментарии в типовых модулях, которые пишутся в одну строку - разработчики пишут в две. Например,

// Восстанавливает из переданной строки запрещенные символы в именах элементов формы
//
Функция ВосстановитьЗапрещенныеСимволы(Знач СтрокаДляЗамены) Экспорт

Когда в конфигураторе стоит группировка комментариев, то эти комментарии группируются и по каждому приходится тыкать - чтобы посмотреть, что во второй строке.
Зачем они оставляют вторую пустую строку, с какой целью???
1 1Сергей
 
24.08.11
09:14
Им за символы платят
2 mishaPH
 
24.08.11
09:15
(0) скорее всего так шаблон настроен чтобы гарантирована была пустая строка между комментом и кодом.

(1) за строки наверное
3 Планета Обезьян
 
24.08.11
09:16
(2)зачем она нужна,эта пустая строка с комментарием. Почему просто не оставлять пустую строку и не улучшить жизнь тысячам программистов?
4 mishaPH
 
24.08.11
09:17
(3) а х.з.
5 Холст
 
24.08.11
09:34
8 Reaper_1c
 
24.08.11
09:40
(0) Прально! Давай вообще текст без форматирования писать! Вон сколько места на мониторе сэкономим! Скольким программистам от этого жить станет легче то...
9 zak555
 
24.08.11
09:40
(8) ты веришь комментариям ?
10 Reaper_1c
 
24.08.11
09:41
И да, для тех кто в танке - отключи свертку комментариев и наслаждайся
11 Ksandr
 
24.08.11
09:41
ну, если Вы нажмете Сtrl+space, а потом мышкой наведете на процедууру/функцию то многострочный коммент там появится, а однострочный нет.
12 Sammo
 
24.08.11
09:48
Насколько я понимаю - это их стандарт. Они всегда должны оставлять строку между комментарием и процедурой/функцией
И хотя в "Системе стандартов и методик разработки конфигураций для платформы 1С:Предприятие 8" это в явном виде не указано, но в примерах они всегда добавляются.

Предположительно для большей читабельности комментария
13 Дикообразко
 
24.08.11
09:49
(11)т.е. так обходят баг интелинса?
14 Варвар
 
24.08.11
09:51
(13) Какой баг?
15 VladZ
 
24.08.11
09:52
(0) Видимо для того, чтобы визуально разделить коммент и функцию.
16 VladZ
 
24.08.11
09:55
Меня раздражает вот такой код:

Если <Условие> Тогда <Какое-то действие> Иначе Возврат КонецЕсли;
17 Alexandr Puzakov
 
24.08.11
09:55
(0) а что в этом плохого?
18 0xFFFFFF
 
24.08.11
10:00
(0) тоже всегда делаю так.
Потому что в свернутом виде идет

+/////////////////////////////
+Процедура МояПроцедура1()

+/////////////////////////////
+Процедура МояПроцедура2()

+/////////////////////////////
+Процедура МояПроцедура3()

+/////////////////////////////
+Процедура МояПроцедура4()

+/////////////////////////////
+Процедура МояПроцедура5()

Это называется ЕДИНООБРАЗИЕ. И воспринимается гораздо лучше чем

+/////////////////////////////
+Процедура МояПроцедура1()

/////////////////////////////
+Процедура МояПроцедура2()

+Процедура МояПроцедура3()
+/////////////////////////////

+Процедура МояПроцедура4()

+Процедура МояПроцедура5()
19 0xFFFFFF
 
24.08.11
10:02
+(18) И меня жутко бесит, когда пишут не как в (0)
20 Планета Обезьян
 
24.08.11
10:03
(18)а  ты эти комменты читаешь? Тебя не напрягает каждый раз раскрывать "пустышки"?
21 0xFFFFFF
 
24.08.11
10:06
(20) без надобности не открываю. Но лучше пусть с пустышками код будет зато оформлен по единой схеме.
22 Планета Обезьян
 
24.08.11
10:15
(21)ога. Как в армии - зимой в камке холодно, а летом - жарко) зато -  едино))

Я думаю, единая схема была бы понятнее, если бы однострочные комментарии писались в одну строку, многострочные - в несколько. Тогда сразу было бы видно, где раскрывать комментарии, а где - нет. И читатебельность от этого только возросла бы
23 John83
 
24.08.11
10:18
(16) чем же раздражает? и как по-твоему нужно делать?
24 mirosh
 
24.08.11
10:19
(22) единые стандарты комментирования есть, и разработчики типовых их чаще всего соблюдают. Сами стандарты можно посмотреть на диске ИТС.
25 0xFFFFFF
 
24.08.11
10:24
(23)
тем же самым, что и отличие
Если А=В Тогда
С=0;
КонецЕсли;

И
Если А=В Тогда С=0;КонецЕсли;
26 Sammo
 
24.08.11
10:27
(24) Про доп строку там, емнип, нет такого.
Это как с функцией после директивы препроцессора, когда автовыравнивание добавляет после нее отступ (в 8.1), в примерах стоит без выравнивания, а в стандартах не описано
27 Inform
 
24.08.11
10:29
(0) только ради того, чтобы комментарии сворачивались
28 VladZ
 
24.08.11
10:31
(23) Тем, что в одну строчку написан. Отлаживать неудобно.
29 mirosh
 
24.08.11
10:33
(26) в стандартах доп. строка в комментирования процедур и функций описана. Я помню. также в примерах (там же) она есть. Другое дело, что комментарий функции одной строкой - вот этого как раз нет в стандартах.
30 Sammo
 
24.08.11
10:38
(29) В примерах - есть. Но не описано. Специально посмотрел на июльском ИТС, раздел "Описаниепроцедур и функций" в "Системе стандартов..."
Там нет "в конце комментария пустая строка" в явном виде (см. например пункт 1.5 Структура комментария)
31 Steel_Wheel
 
24.08.11
12:23
(3) Читабельность. Вообще, глаза устают меньше
32 Steel_Wheel
 
24.08.11
12:24
(3) в твоем варианте слова "ухудшить" слишком много ошибок
33 Эльниньо
 
24.08.11
12:30
Долой комментарии. Правильный программист должен сходу любой гКод понять.
34 John83
 
24.08.11
13:36
(28) аа... я уж было подумал, что есть какая-то другая крутая фишка...
35 John83
 
24.08.11
13:38
+(34) а как отношение к такому?

Попытка
 док.Записать();
Исключение КонецПопытки;

ИнформациюОбОшибке в расчет не берем
36 Vetal_978
 
24.08.11
13:47
(19) тоже всегда как в (0) делаю.