Содержание

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

Содержание раздела

Настройка

Функция комментирования страниц, встроенная в CMS «Простой бизнес», позволяет посетителям сайта оставлять комментарии к различной информации, размещенной на нем. Разработчики сайта могут гибко настраивать права доступа к комментированию страниц, форму комментирования и осуществлять предмодерацию оставленных посетителями сайта комментариев. Функция комментирования – универсальный и простой для пользователя способ включить комментирование на его сайте.

  • Способ комментирования – выпадающий список, в котором можно выбрать варианты комментирования на сайте: встроенный, vk.com, facebook.com
  • Пагинация – функция, позволяющая при большом количестве комментариев разбивать их на страницы. По умолчанию в настройках будет стоять значение (20), это поле будет редактируемым и пользователь сможет сам указать количество записей на странице.
  • Доступ для роли – поле для выбора ролей пользователей, которым будет доступно комментирование на сайте. По умолчанию здесь установлена роль «Зарегистрированный».
  • Идентификатор приложения VK – поле для ввода id приложения. Данное поле обязательно для заполнения при подключенном способе комментирования «vk.com». Для vk.com достаточно перейти на страницу.
  • Идентификатор приложения Facebook – при выборе способа комментирования страниц сайта в фейсбуке достаточно выполнить следующие действия: перейти на страницу https://developers.facebook.com/apps и зарегистрироваться как разработчик, затем выбрать пункт «Создать новое приложение» и ввести нужные данные о сайте. На странице появится значение App ID: XXXXXX, где XXXXXX – id приложения. После этого нужно получить id пользователя, для этого можно следовать следующей инструкции.
  • Включить комментирование для всех страниц – данная функция позволяет подключить возможность комментирования всех страниц сайта одним нажатием кнопки.
  • Отправлять комментарии на e-mail – на электронный адрес модератора будет приходить сообщение следующего вида: Название страницы (title), на которой был размещен комментарий, затем текст комментария и гиперссылки: Открыть страницу, Удалить, Ответить.

Открыть страницу – открывается страница, на которой был оставлен данный комментарий;

Удалить – данный комментарий будет удаляться;

Ответить – открывается окно для ввода ответа на сайте на данный комментарий.

  • Отправлять комментарии в задачу – Подключение этого пункта будет означать, что по умолчанию комментарии отправляются в задачу. Эта задача создается при создании первого комментария на сайте или по нажатию кнопки «Создать», справа в поле создания задачи в древовидной формы. По умолчанию задача назначается создателю сайта. В комментариях будет отображаться его содержимое и ссылки: Открыть страницу, Удалить, Ответить:

Открыть страницу – открывается страница, на которой был оставлен данный комментарий

Удалить – данный комментарий будет удаляться.

Ответить – будет открываться окно для ввода ответа на сайте на данный комментарий.

  • Защитный код – возможность подключения возможности ввода защитного кода в форме комментирования перед отправкой комментария. Это позволит исключить попадания на сайт спам-рассылок, осуществляемых компьютерными ботами.

На панели управления страницей в правой части редактора CMS, в разделе «Дополнительные свойства» расположены функции:

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

«Комментировать вложенные» – функция доступна только на уровне разделов сайта и не распространяется на сам раздел. Т.е. в этом случает подключается комментирование вложенных страниц, а для страницы раздела комментирование определяется настройкой функции «Разрешить комментирование», описанной выше.

Как это работает на сайте

При подключенной функции«Отправлять комментарии в задачу» создается задача «Комментарии», вложенная в задачу с сайтом. В данную задачу будут поступать сообщения. Создание задачи сопровождается оповещением.

Чтобы оставить комментарий, достаточно в блоке «Комментировать» вписать комментарий, защитный код и нажать «Отправить».

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

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

Возле текста комментария (справа внизу) расположена кнопка «Ответить». При нажатии на нее пользователь может ответить на комментарий, оставленный другим пользователем.

Если пользователь передумал писать комментарий или отвечать пользователю, он может нажать на кнопку «Отмена» и текст комментария сотрется.

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

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

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

Модерация

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

  • Использовать предмодерацию – выбор данного пункта позволит модератору сайта просматривать комментарии, оставленные пользователями, прежде чем они попадут на страницу. По умолчанию сообщения будут попадать сразу в задачу «Комментарии», в которой модератор сможет либо удалить это сообщение или подтвердить добавление этого комментария в ленту. Таким образом, можно избежать попадания на сайт спама, флуда, оскорблений и т.д.

При отправке комментария на сайте появляется оповещение «Комментарий отправлен на модерацию».

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

При выборе последнего пункта открывается страница с комментариями и, если модератор войдет под своими учетными данными на сайт, ему будут доступны ссылки «Удалить» и «Скрыть».

В зависимости от выбранного модератором действия, на сайте вместо комментария отображается его статус.

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

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

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

Хорошие против плохих комментариев

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

Например, это довольно бесполезный комментарий:

b = 56                       # assigning b a value of 56

Следующий пример демонстрирует более полезный комментарий и дает переменным очевидные имена:

salestax10 = 1.10            # defining a sales tax of 10%  
salestax20 = 1.20            # defining a sales tax of 20%

Существует бесконечное количество других сценариев, которые заслуживают комментариев. Это только один пример. Хорошее практическое правило — добавлять комментарии к любой строке кода (например, к списку) или к фрагменту кода, цель которого не очевидна. Это очень субъективно, и на самом деле это навык, который необходимо изучить.

Типы комментариев

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

В следующих разделах я опишу каждый тип комментария.

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

Такой комментарий начинается с хеш-символа ( #) и сопровождается текстом, который содержит дополнительные пояснения.

# defining the post code
postCode = 75000

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

# define the general structure of the product with default values
product = {  
   "productId": 0,          # product reference id, default: 0
   "description": "",       # item description, default: empty
   "categoryId": 0,         # item category, default: 0
   "price": 0.00            # price, default: 0.00
}

Руководство по стилю для кода Python ( PEP8 ) рекомендует менее 79 символов на строку. На практике 70 или 72 символа в строке легче читать, и поэтому рекомендуется. Если ваш комментарий приближается к этой длине или превышает ее, тогда вы захотите распределить его по нескольким строкам.

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

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

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

Версия 1 объединяет однострочные комментарии следующим образом:

# LinuxThingy version 1.6.5
#
# Parameters:
#
# -t (--text): show the text interface
# -h (--help): display this help

Версия 2 проще, чем версия 1. Изначально она предназначалась для создания документации (подробнее об этом ниже), но ее также можно использовать для многострочных комментариев.

"""
LinuxThingy version 1.6.5

Parameters:

-t (--text): show the text interface
-h (--help): display this help
"""
 

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

Обычная практика

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

Этот фрагмент взят из одного из примеров, которые я использую в учебных целях. Комментарий начинается с описания, за ним следует уведомление об авторских правах с моим именем и год публикации кода. Ниже вы увидите, что код лицензирован под GNU Public License ( GPL ). Для того, чтобы связаться со мной, мой адрес электронной почты также добавлен туда.

# -----------------------------------------------------------
# demonstrates how to write ms excel files using python-openpyxl
#
# (C) 2015 Frank Hofmann, Berlin, Germany
# Released under GNU Public License (GPL)
# email [email protected]
# -----------------------------------------------------------

Комментарии документации

Python имеет встроенную концепцию под названием «строки документации», которая является отличным способом связать написанную вами документацию с модулями, функциями, классами и методами Python. Строка документа добавляется в качестве комментария прямо под заголовком функции, модуля или объекта и описывает действия функции, модуля или объекта. Ожидается, что будут следовать этим правилам:

Строка документа — это либо однострочный, либо многострочный комментарий. В последнем случае первая строка является кратким описанием, а после первой строки следует пустая строка.

Начните строку документа с заглавной буквы и завершите ее точкой.

Это основной пример того, как это выглядит:

def add(value1, value2):  
   """Calculate the sum of value1 and value2."""
   return value1 + value2

В интерактивной справочной системе Python строка документации становится доступной через атрибут __doc__.

>>> print add.__doc__
Calculate the sum of value1 and value2.

Существует ряд инструментов, которые автоматически генерируют документацию из строк документации, таких как Doxygen, PyDoc, pdoc и расширение autodoc для Sphinx. Мы объясним вам, как работать с ними в следующей статье.

Заключение

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

Перевод статьи: Commenting Python Code

Комментирование в блогосфере носит «фанатский» характер – Новости – Научно-образовательный портал IQ – Национальный исследовательский университет «Высшая школа экономики»

Комментаторская активность в Живом Журнале (ЖЖ) чаще сосредоточена вокруг топовых блогеров. Авторство постов играет большую роль в образовании дискуссий, чем тематика. К таким выводам в ходе исследования пришли ученые из Лаборатории интернет-исследований (ЛИНИС, Санкт-Петербург) НИУ ВШЭ Олеся Кольцова, Сергей Кольцов и Сергей Николенко

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

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

Пытаясь проверить это предположение, исследователи обратились к материалам Живого журнала. Именно ЖЖ был выбран в качестве объекта исследования, поскольку в России до недавнего времени большая часть социально-политических дискуссий была сосредоточена в рамках этого ресурса.

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

В выборку вошли все посты двух тысяч самых популярных блогеров ЖЖ, написанные в течение недельного периода. Именно в диапазоне верхних двух тысяч блогов комментариев достаточно для образования «облаков» или сообществ, отмечают авторы в докладе, посвященном результатам исследования. «Эксперименты с рейтингами показали, что уже на уровне 50-тысячного места количество комментариев почти вдвое меньше количества постов и составляет менее трех комментариев на блогера, – пишут исследователи. – Если учесть, что эти блогеры – уже не знаменитости, вероятность комментирования разных постов одним и тем же пользователем крайне мала».

Также из всех предыдущих исследований лаборатории известно, что на топ-2000 блогеров (примерно 1% от всех аккаунтов) приходится почти в двадцать раз больше комментариев, чем постов, и здесь в выборку попадают активные комментаторы, оставляющие множество комментариев, отметили ученые.

Выбор недельного периода для анализа (с 1 по 7 апреля 2013 года) авторы объясняют тем, что большинство комментариев к посту обычно появляется в течение нескольких дней. После исключения постов, не имеющих комментариев, в исследовательском фокусе внимания оказалось 17386 постов, написанных 1667 авторами. Количество комментариев к ним составило 520 тысяч. Они были оставлены примерно 56 тысячами блогеров.

В исследовании был использован метод сетевого анализа. Графически, посты были представлены в виде точек, а наличие у двух постов общего комментатора обозначалось линией, соединяющей эти точки. Такой объект в математике называется графом. Те участки графа, где линий-связей между точками особенно много, указывают на наличие множества одних и тех же комментаторов у примерно одних и тех же постов. Чтобы выявить такие участки в большом графе с десятками тысяч точек и сотнями тысяч линий, использовался специальный алгоритм, называемый алгоритмом выявления сообществ. Термин «сообщество» здесь означает наиболее «густой» участок графа.

Первично авторство, а не тема

Анализ показал, что большое количество (85) мелких сообществ – это диады и триады, зачастую изолированные и не представляющие содержательного интереса. Это, по словам авторов, одно из последствий неравномерного распределения числа комментариев на пост и особенно числа комментариев на комментатора. Около трети комментаторов в выборке оставили всего по одному комментарию и, таким образом, вообще не участвуют в графе со-комментирования. Остальная группа сформирована по большей части менее чем тысячей активных комментаторов, сгенерировавших от ста до примерно тысячи комментариев каждый. На эту группу приходится две трети всех комментариев. Самое большое сообщество не представляет существенного интереса так же, как и самые маленькие. Это «разговор всех обо всем». Потенциально интересными оказались около семидесяти средних сообществ.

Исследование показало, что сообщества имеют выраженную тенденцию центрироваться вокруг авторов комментируемых постов, которые таким образом могут считаться лидерами мнений. «Правда, их локальное, применимое к данному сообществу лидерство может носить латентный характер, так как и сами сообщества могут быть латентными, и их существование может не осознаваться участниками», – поясняют исследователи. Это возможно потому, что, комментируя разные посты одного автора, пользователи могут не вступать в коммуникацию с другими блогерами, или, во всяком случае, не осознавать границ того круга людей, который активно комментирует этого автора.

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

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

См. также:

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

 

Подпишись на IQ.HSE

Комментирование кода 1С

Комментирование кода —  это внесение пояснений в тест модулей, которые не является обязательными и не влияют на алгоритм (не исполняются)

Производится только с помощью последовательности «//«, при этом комментарием считается все, что находится после.

Пример комментария:

Перем ЭтоНеКомментарий;\\ А это уже комментарий \\Это тоже комментарий

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

Возможно использование в подряд идущих комментариев:

//Это первая строка комментария
//Это вторая строка комментария

//Строка комментария после пустой строки 
// Перем А;//Эта переменная не объявится

Горячие клавиши

ctrl + / — добавить комментарий в выделенных строках;

ctrl + shift + / — удалить комментарий в выделенных строках

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

Установка и снятие комментария интерактивно по кнопкам:

Выделяется код и нажимаются на панели «Модуль» соответствующие кнопки «Добавить комментарий» и снять «Комментарий»

 

или более длинный путь:

Меню «Текст\Блок\Добавить комментарий» или «Текст\Блок\Удалить комментарий«

 

Должен заметить, что текст комментариев —  только для программистов, пользователь его не увидит, и служит для:

  • описания сложных участков кода или алгоритма
  • логического отделения блоков непрерывного кода, в данном случае поле «\\» ничего не пишется
  • описания функций и процедур
  • выделения изменений в код типовых конфигураций, при обновлении упростит разбор
  • описания ситуации внесения изменений, даты
  • отметка ошибочного или сомнительного кода, в процесcе code review (анализа  качества кода 1С)

Правила комментирования кода действуют и для языка запросов 1С, но важно отметить, что  при использовании Конструктора запроса(визуального средства разработки запроса к базе), комментарии удаляются полностью, а не снимается признак «\\».

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

Настроить это можно в меню «Сервис\Параметры» далее вкладки «Модули\Группировка»

Там же на вкладке «Модули\Редактирование» возможно отключить или поменять цвет выделения комментария с зеленого (по умолчанию)

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

 

Большой рекламный бюджет не ведет к высокому уровню сбыта. Наоборот, высокий уровень сбыта ведет к большому рекламному бюджету.

— К. Мейсон

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

Добавление комментария к задаче является полезным способом записи дополнительной информации о задаче и совместной работы с членами команды. Комментарии отображаются на вкладке «Комментарии» (Comments) раздела «Активность» (Activity) при просмотре задачи.

Примечание: 

  • При добавлении комментария вы можете установить комментарий для просмотра (Viewable by) только членами определенной роли проекта или группой пользователей; или вы можете разрешить  просматривать его всем пользователям.
  • Чтобы пользователи могли просмотреть комментарий, у них должно быть разрешение на просмотр проекта (Browse Project)  для просмотра задачи и для каждого комментария, они должны быть частью просмотра  (Viewable by) пользователями (см. Добавление комментария  ниже).
  • Вы автоматически становитесь наблюдателем задачи, которую вы можете прокомментировать. Вы можете отключить это с помощью опции «Настройки»> «Авточасы» (Preferences > Autowatch) в вашем профиле.

Добавление комментария

Для того, чтобы добавить комментарий к задаче, то есть увидеть кнопку «Комментарий»(Comment), у вас должно быть оба разрешения для соответствующего проекта:

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

1. Откройте задачу, для которой следует добавить свой комментарий.

2. Нажмите кнопку «Комментарий» (Comment).

комбинация клавиш: m

3. В текстовом поле «Комментарий» (Comment) введите свой комментарий, используя столько строк, сколько вам нужно.

 Вы можете использовать разметку wiki в этом текстовом поле, если включен визуализатор стилей Wiki Style Renderer.

   Чтобы применить ограничения просмотра комментариев(To apply viewing restrictions to a comment), нажмите значок открытого замка рядом с пунктом «Доступно для просмотра»(Viewable by) и выберите, какие пользователи смогут просмотреть этот комментарий.

Список  «Доступно для просмотра» (Viewable by) также включает все роли и группы проектов, к которым вы принадлежите. (Обратите внимание, что All Users означает всех, кто использует JIRA, тогда как «Пользователи» означает всех, кто является участником роли проекта «Пользователи» в этом проекте.) В зависимости от того, как администратор JIRA настроил «видимость комментариев», список «Доступный для просмотра» может включать группы, а также роли проекта.

После того, как для комментария были применены ограничения просмотра, значок замка закрывается, а «Доступно для просмотра» (Viewable by)  заменяется на «Ограничено,только для … »(Restricted to..) и указывает пользователя, роль или группу проекта, которые могут просматривать этот комментарий, например: (Только для пользователей).

   Чтобы отправить другим пользователям сообщение о своем комментарии(To email other users about your comment: ), просто укажите этих пользователей в текстовом поле «Комментарий»(Comment). Сообщение электронной почты будет отправлено на адрес электронной почты пользователя, зарегистрированный в его учетной записи JIRA после нажатия кнопки «Обновить»(Update). См. Отправка сообщения электронной почты о задаче пользователям, указав их для получения подробной информации о правильном синтаксисе.

4.  Нажмите кнопку «Добавить»(Add), чтобы сохранить комментарий.

 Для каждого комментария по задаче слева от имени пользователя появляется небольшая версия аватара пользователя — автора комментария.

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

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

1. Найдите комментарий в разделе «Активность» (Activity) внизу задачи.

2. Перейдите к комментарию, который вы хотите свернуть / развернуть.

3. Чтобы свернуть или развернуть комментарий, щелкните значок стрелки, расположенный в комментарии:

            

 Сворачивание или расширение комментария никак не связано с «ограничениями просмотра» комментариев, применяемыми при добавлении или редактировании комментария.

Редактирование комментария

Вы можете редактировать свои собственные комментарии, если вам предоставлено разрешение проекта на редактирование собственных комментариев (Edit Own Comments).

Вы можете редактировать комментарии других людей, если вам предоставлено разрешение проекта на редактирование всех комментариев (Edit All Comments).

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

1. Найдите комментарий в разделе «Активность» (Activity) внизу задачи.

2. Перейдите к комментарию, который вы хотите отредактировать.

3. Нажмите значок «Редактировать» (Edit) (карандаш), расположенный в комментарии.

4. При необходимости отредактируйте текст комментария и / или его вид по списку (Viewable by).

5. Нажмите кнопку «Сохранить» (Save).

6. Появится слово «отредактировано», чтобы указать, что комментарий был отредактирован. Вы можете навести указатель мыши на слово «отредактировано», чтобы узнать, кто редактировал комментарий и когда.

  

Удаление комментария

Вы можете удалить свои собственные комментарии, если вам предоставлено разрешение проекта на удаление собственных комментариев (Delete Own Comments).

Вы можете удалить комментарии других людей, если вам предоставлено разрешение проекта на удаление всех комментариев (Delete All Comments).

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

1. Наведите указатель мыши на комментарий, который хотите удалить.

2. Нажмите значок «Удалить» (Delete) (значок корзины), расположенный в комментарии.

3. Подтвердите удаление, нажав кнопку «Удалить» (Delete).

Ссылка на комментарий

Иногда вам может потребоваться ссылка на конкретный комментарий к задаче JIRA.

1. Перейдите к комментарию, на который хотите установить ссылку.

2. Щелкните правой кнопкой мыши значок Permlink (ссылка), расположенный в комментарии, затем скопируйте постоянную ссылку на комментарий.

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

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

Похожие темы

 

Улучшенное комментирование документов | Altium Designer 21 Руководство пользователя

В сочетании с недавними обновлениями функций комментирования в Altium 365 Workspace, Altium Designer теперь предлагает подобный набор обновленных и улучшенных возможностей комментирования, доступных при подключении к серверу Altium. Комментирование в редакторах проекта было значительно улучшено с точки зрения графики, удобства использования и получения связанной информации, с сохранением обратной совместимости с комментариями, размещенными ранее.

Далее приведен список примечательных обновлений системы комментирования, которые также показаны на видео ниже:

  • Размещение: Размещение комментариев в редакторе теперь осуществляется в помощью единой кнопки , доступной в обновленной панели Comments. В режиме размещения комментария, курсор обнаруживает и подсвечивает объекты для выделения:
    • Щелкните ЛКМ по подсвеченному объекту, чтобы открыть диалоговое окно ввода комментария, который будет применен к выделенному объекту.
    • Щелкните ЛКМ по области, которая не подсвечена, чтобы открыть диалоговое окно ввода комментария, который будет применен к этой точке.
    • Либо щелкните ЛКМ вне объектов, переместите курсор мыши, чтобы сформировать подсвеченную область, затем щелкните еще раз, чтобы зафиксировать ее конечную форму и открыть диалоговое окно ввода комментария, который будет применен к объектам внутри указанной области.

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

  • Упоминания и назначения: Помимо ввода любого текста в диалоговое окно комментария, вы можете добавить ссылку с упоминанием любого другого пользователя или роли, которые зарегистрированы в подключенном Workspace. Введите символ @ или нажмите кнопку . Выберите имя/email из выпадающего списка, чтобы добавить в комментарий ссылку на пользователя (участника команды), а также чтобы указать его в качестве записи Assign To. Отключите эту опцию, если вы не хотите, чтобы комментарий считался назначенным этому определенному пользователю. Роль (например, ‘Engineers’) и, соответственно, входящих в нее пользователей, также можно добавить в виде упоминания и/или назначения.

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

    ► Получите более подробную информацию о публикации проекта

  • Определение положения: Для изменения положения комментария в области редактора перетащите его «выноску» в новое место. Когда выноска комментария выделена, будет отображена линия соединения со связанным объектом или областью. Используйте кнопку в панели Comments для управления видимостью выносок (и связанных с ними комментариев) в рабочей области редактора.
  • Рисование от руки: При размещении или редактировании комментария нажмите кнопку , чтобы добавить рисунок, сделанный от руки, с помощью курсора в виде карандаша. Щелкните ПКМ, чтобы завершить команду и связать рисунок с выбранным в данный момент комментарием.

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

Чтобы открыть существующий комментарий (свой или другого пользователя), щелкните ЛКМ по его выноске в рабочей области или по его строке в панели Comments. Приведенный далее обзор функциональных возможностей можно увидеть на видео ниже:

  • Предварительный просмотр: Размещенные комментарии включают в себя связанное изображение предварительного просмотра, зафиксированное при начальном размещении комментария. Чтобы открыть миниатюру изображения, используйте ссылку Show original design screenshot в диалоговом окне открытого комментария.
  • Ответ: Открытый комментарий, по сути, находится в режиме ответа, с возможностью упоминания пользователя Workspace.
    • Нажмите кнопку , чтобы добавить введенный ответ в ветвь комментария.
    • Нажмите кнопку , чтобы разрешить комментарий (закрыть как завершенный).
    • Щелкните ЛКМ в рабочей области редактора, чтобы закрыть диалоговое окно комментариев.

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

Далее приведены другие аспекты новой системы комментирования, и их можно увидеть на видео ниже:

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

Комментарии также можно размещать на плате в рабочей области редактора плат тем же самым образом, что и в редакторе схем. При выборе строки комментария в панели Comments, система откроет (и при необходимости загрузит) связанные проектные документы.

Комментарии в С++ | Уроки С++

  Обновл. 19 Сен 2020  | 

Комментарий — это строка (или несколько строк) текста, которая вставляется в исходный код для объяснения того, что делает код. В языке C++ есть 2 типа комментариев: однострочные и многострочные.

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

Однострочные комментарии — это комментарии, которые пишутся после символов //. Они пишутся в отдельных строках и всё, что находится после этих символов комментирования, — игнорируется компилятором, например:

std::cout << «Hello, world!» << std::endl; // всё, что находится справа от двойного слеша, — игнорируется компилятором

std::cout << «Hello, world!» << std::endl; // всё, что находится справа от двойного слеша, — игнорируется компилятором

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

std::cout << «Hello, world!» << std::endl; // cout и endl находятся в библиотеке iostream std::cout << «It is so exciting!» << std::endl; // эти комментарии усложняют чтение кода std::cout << «Yeah!» << std::endl; // особенно, когда строки разной длины

std::cout << «Hello, world!» << std::endl; // cout и endl находятся в библиотеке iostream

std::cout << «It is so exciting!» << std::endl; // эти комментарии усложняют чтение кода

std::cout << «Yeah!» << std::endl; // особенно, когда строки разной длины

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

// cout и endl находятся в библиотеке iostream std::cout << «Hello, world!» << std::endl; // теперь уже легче читать std::cout << «It is so exciting!» << std::endl; // не так ли? std::cout << «Yeah!» << std::endl;

// cout и endl находятся в библиотеке iostream

std::cout << «Hello, world!» << std::endl;

 

// теперь уже легче читать

std::cout << «It is so exciting!» << std::endl;

 

// не так ли?

std::cout << «Yeah!» << std::endl;

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

Многострочные комментарии — это комментарии, которые пишутся между символами /* */. Всё, что находится между звёздочками, — игнорируется компилятором:

/* Это многострочный комментарий. Эта строка игнорируется и эта тоже. */

/* Это многострочный комментарий.

Эта строка игнорируется

и эта тоже. */

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

/* Это многострочный комментарий. * Звёздочки слева * упрощают чтение текста */

/* Это многострочный комментарий.

* Звёздочки слева

* упрощают чтение текста

*/

Многострочные комментарии не могут быть вложенными (т.е. одни комментарии внутри других):

/* Это многострочный /* комментарий */ а это уже не комментарий */ // Верхний комментарий заканчивается перед первым */, а не перед вторым */

/* Это многострочный /* комментарий */ а это уже не комментарий */

// Верхний комментарий заканчивается перед первым */, а не перед вторым */

Правило: Никогда не используйте вложенные комментарии.

Как правильно писать комментарии?

Во-первых, на уровне библиотек/программ/функций комментарии отвечают на вопрос «ЧТО?»: «Что делают эти библиотеки/программы/функции?». Например:

// Эта программа вычисляет оценку студента за семестр на основе его оценок за модули // Эта функция использует метод Ньютона для вычисления корня функции // Следующий код генерирует случайное число

// Эта программа вычисляет оценку студента за семестр на основе его оценок за модули

 

// Эта функция использует метод Ньютона для вычисления корня функции

// Следующий код генерирует случайное число

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

Во-вторых, внутри библиотек/программ/функций комментарии отвечают на вопрос «КАК?»: «Как код выполняет задание?». Например:

/* Для расчета итоговой оценки ученика, мы складываем все его оценки за уроки и домашние задания, а затем делим получившееся число на общее количество оценок. Таким образом, мы получаем средний балл ученика. */

/* Для расчета итоговой оценки ученика, мы складываем все его оценки за уроки и домашние задания,

   а затем делим получившееся число на общее количество оценок.

   Таким образом, мы получаем средний балл ученика. */

Или:

// Чтобы получить рандомный (случайный) элемент, мы выполняем следующее: // 1) Составляем список всех элементов. // 2) Вычисляем среднее значение для каждого элемента, исходя из его веса, цвета и цены. // 3) Выбираем любое число. // 4) Определяем соответствие элемента случайно выбранному числу. // 5) Возвращаем случайный элемент.

// Чтобы получить рандомный (случайный) элемент, мы выполняем следующее:

 

// 1) Составляем список всех элементов.

// 2) Вычисляем среднее значение для каждого элемента, исходя из его веса, цвета и цены.

// 3) Выбираем любое число.

// 4) Определяем соответствие элемента случайно выбранному числу.

// 5) Возвращаем случайный элемент.

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

В-третьих, на уровне стейтментов (однострочного кода) комментарии отвечают на вопрос «ПОЧЕМУ?»: «Почему код выполняет задание именно так, а не иначе?». Плохой комментарий на уровне стейтментов объясняет, что делает код. Если вы когда-нибудь писали код, который был настолько сложным, что нужен был комментарий, который бы объяснял, что он делает, то вам нужно было бы не писать комментарий, а переписывать этот код.

Примеры плохих и хороших однострочных комментариев:

// Присваиваем переменной sight значение 0

sight = 0;

// Игрок выпил зелье слепоты и ничего не видит

sight = 0;

// Рассчитываем стоимость элементов

cost = items / 2 * storePrice;

// Нам нужно разделить все элементы на 2, потому что они куплены по парам

cost = items / 2 * storePrice;

// Мы решили использовать список вместо массива,

// потому что массивы осуществляют медленную вставку.

// Мы используем метод Ньютона для вычисления корня функции,

// так как другого детерминистического способа решения этой задачи — нет.

//    std::cout << 1;

std::cout << 1;

std::cout << 2;

std::cout << 3;

//    std::cout << 1;

//    std::cout << 2;

//    std::cout << 3;

/*

     std::cout << 1;

     std::cout << 2;

     std::cout << 3;

*/