Как сделать комментарий в 1с

Добавил пользователь Дмитрий К.
Обновлено: 05.10.2024

При создании Счета в 1С можно написать комментарий (например, "оплата за 2-ой квартал"). Но когда этот счет отправляешь на печать - комментарий не выводиться. Как включить Комментарий в распечатку Счета, чтобы он выводился на печать автоматически. Как изменить печатную форму, какой параметр внести. То же самое касается Акта.

ни в коем случае не надо менять печатную форму (=
потом проблем будет много (=

если количество счетов и актов не очень большое, то лучше руками вставлять коментарий перед печатью
(нужно нажать "волшебную кнопку" и печатную форму можно будет редактировать)

если руками не хочется, то закажите внешние печатные формы для счета и акта с коментарием
это будет не дешево, зато проблем в будущем не возникнет (=

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

з. ы. это все касательно 1С8, в 7.7 примерно тоже самое, только понятия "поддержка" нет (=

В этой статье мы рассмотрим комментирование управляющих структур и методов.

Комментарии управляющих структур

Самое подходящее место для комментирования управляющей структуры - предшествующие ей строки. Если это условный оператор, то в комментарии можно пояснить условие и результаты. Если это цикл, можно указать его цель.

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

Пишите комментарии перед каждым условным оператором (Если, If, Case и пр.), перед каждым циклом (Пока, Для каждого, While, …) или группой операторов. Эти конструкции часто требуют пояснения, а место перед ними лучше всего подходит для этого. Используйте комментарии для пояснения цели управляющих структур.

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

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

Рассматривайте комментарии в концах управляющих операторов как предупреждения о сложности кода. Подумайте, может следует упростить код?

Комментирование методов

Часто дается совет: независимо от сложности (размера) метода необходимо перед его началом необходимо привести подробнейшее описание, с входными данными и выходными, целью и алгоритмом, телефоном автора и адресом и т.д. Нередко это делается для простых методов, вся суть которых видна из названия. Весь метод - три строки и шапка перед ним десять. ЗАЧЕМ? Это лишние усилия и они не окупятся. Кроме того тяжеловесные заголовки заставляют программистов создавать меньше методов.

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

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

Документируйте параметры в местах их объявления. Самый простой способ - написать комментарии после их объявления:

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

Проведите различия между входными и выходными данными. Знать, какие данные являются входными, а какие выходными полезно. Иногда это ясно из контекста, например в Visual Basic выходным данным предшествует ключевое слово ByRef, а входным - ByVal. В C++ указатель объявляется через звездочку, что удобно для выходных данных. Но все же, как правило, лучше идентифицировать входные и выходные параметры явно. Если методы коротки и поддерживается явное различие между входными и выходными данными, документировать статус данных (входной или выходной) наверное не нужно. Однако если метод объемен, указание статуса поможет всем, кто будет читать код метода.

Документируйте предположения. Если вы сделали какие-либо предположения о состоянии получаемых переменных (о допустимых и недопустимых значениях, о том, что массивы должны быть отсортированы, что данные должны быть инициализированы или должны иметь только допустимые значения и т.д.) укажите это или в прологе метода, или в месте объявления данных. Этот вид документации должен присутствовать почти в каждом методе.

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

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

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

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

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

В платформе 1С версии 8 редактор кода автоматически скрывает тесты методов, оставляя лишь первую строку метода и комментарий перед ним. Поэтому маркеры можно использовать для обозначения групп методов, например:

Комментарий (графа) в журналах покупок и продаж (1С 8.3 бух)

Подскажите пожалуйста!
Хочу изменить комментарий в старых, закрытых периодах.
Программа мне после нажатия кнопки "Запись" предлагает всё перепровести, начиная с этой даты.
Как менять комментарий так, чтобы не надо было всё перепрововодить?

Спасибо!
Как жаль.
Так хотелось бы пользоваться комментариями, менять их по необходимости.
Но перепроводить прошлые периоды каждый раз - это невозможно!

в бух 2.0 была внешняя обработка универсальный подбор и обработка документов, отбираешь нужное, выбираешь изменить реквизит-комментарий и пишешь нужное.. Закрытие месяца не страдает, но период должен быть открыт для изменения. В бух 3.0 не знаю есть такая обработка или нет.вероятно работает когда не надо перезаполнять регистры

Обработка, может, и есть, но программа будет считать это измененным документом и требовать перепроведения ВСЕХ документов с даты внесения исправления.
Тоже бесит, тоже хотела найти способ избежать этого.

а точно программа не потеряет какую-нибудь проводку или не сделает какой-то документ непроведенным?

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

Обработка, может, и есть, но программа будет считать это измененным документом и требовать перепроведения ВСЕХ документов с даты внесения исправления.
Тоже бесит, тоже хотела найти способ избежать этого.

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

Настрою вашу 1С. Опыт с 2004 года. Подробнее →

Смотрите видео инструкцию по этой статьей на моём Ютуб-канале (отмотайте видео на 7 мин 12 сек):

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

Далее открывается таблица, очень похожая на Эксель, как в Экселе редактируем данные – раздвигаем строчку, вписываем слова и т.д. более наглядно как это сделать можете посмотреть в видео-инструкции.

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

Смотрите видео презентацию этой статьи (отмотайте видео на 7 мин 12 сек):

Первая фишка. Учимся работать с группировкой кода в программном модуле 1С

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

Платформа 1С позволяет программисту настраивать, какой код должен группироваться и сворачиваться автоматически, а какой нет. Делается это в параметрах конфигурации 1С (Главное меню – Сервис – Параметры) .

Вторая фишка. Используем области кода в программном модуле 1С

Очень часто возникает необходимость объединить ряд процедур и функций (или просто кусок какого-то кода) в один общий логический кусок или блок. Это можно сделать при помощи комментариев, как у меня на рисунке ниже

Области можно вкладывать друг в друга

А так же при помощи областей можно объединять код внутри процедур и функций

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

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

Третья фишка. Быстрый переход к нужной процедуре в программном модуле 1С

При программировании в 1С или отладке кода, часто возникает ситуация, что нужно перейти в код какой-то процедуры или функции. Причем искомая процедура может быть расположена в текущем программном модуле 1С, а может и в каком-то общем программном модуле.

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

В том случае, когда нужная процедура или функция в этом же модуле, курсор перескочит на ее название

Если же процедура находится в каком-то другом модуле (общем, модуле объекта и т.п.), то будет предложено перейти или в этот модуль, или в нужную процедуру.

Четвертая фишка. Узнаем, где используется нужный метод в программном модуле 1С

При разработке периодически может возникнуть необходимость знать, в каком месте кода используется та или иная процедура (функция). Можно конечно скопировать название этой процедуры и сделать глобальный поиск по всей конфигурации, а можно поступить проще. Достаточно просто установить курсор на названии нужного метода и нажать комбинацию клавиш Alt + F12, после этого откроется окно, в котором будут перечислены строки кода, где встречается искомая процедура. Разработчик может из этого окна перейти в интересующее его место.

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

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

Без сложных технических терминов.
Более 500 страниц практического материала.
Каждое задание сопровождается рисунком (скриншот).
Сборник задач для домашней проработки.
Книга написана понятным и простым языком — для новичка.
Книга посылается на электронную почту в формате PDF. Можно открыть на любом устройстве!

Промо-код на скидку в 16%: vCph8bW3rE

Эта книга подойдёт тем, кто уже начал программировать и испытывает определенные сложности с этой темой и тем, кто уже давно программирует, но ни разу еще не работал с управляемыми формами 1С

Без сложных технических терминов;
Более 600 страниц практического материала;
Каждый пример сопровождается рисунком (скриншот);
Книга посылается на электронную почту в формате PDF. Можно открыть на любом устройстве!

Промо-код на скидку в 15% — 48PVXHeYu

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

можно оплатить вручную:

Яндекс.Деньги — 410012882996301
Web Money — R955262494655

Вступайте в мои группы в соцсетях, и будьте в курсе всех новостей

One thought on “ Четыре фишки, как улучшить свою работу с кодом в 1С ”

Читайте также: