Описание тега code-comments

Вопросы с тегом
4 ответа

Предотвращение удаления комментариев HTML при использовании jquery .html()

Возможный дубликат: Выбор комментариев HTML с помощью jQuery Функции Ajax, такие как.load(), удаляют комментарии из HTML. Как я могу сохранить комментарии? Мы делаем AJAX-вызов, результат которого приходит через $('#page_section').html(result); Проб…
04 дек '12 в 18:13
1 ответ

Удаление комментариев из файлов проекта только для сборки выпуска

Я работаю над несколькими проектами ASP.NET/SharePoint C#. В процессе разработки мы используем детальные комментарии для лучшего понимания. Но прежде чем я хочу дать релиз сборки, я хочу спрятать все комментарии (не удалять их). Есть ли плагин VS ил…
18 ноя '10 в 12:36
1 ответ

Обновление комментариев vsdoc в JavaScript

Есть ли инструмент для обновления комментариев VSDoc в библиотеке javascript? Теперь у меня есть документация в комментариях VSDoc в файле javascript и в отдельном файле xml. И если я хочу что-то изменить, мне нужно изменить это в обоих местах. Было…
02 мар '11 в 04:11
2 ответа

Что подразумевается под тегом @file в dockblock

Я использую phpCheckstyle phpcheckstyle для стандартизации моего комментирования кода. После проверки файла в предупреждении предлагается "Комментарии блока документа должны содержать информацию о файле (@file) для каждого файла PHP". Предупреждение…
16 июл '14 в 08:33
2 ответа

Комментарии Javascript для вызовов ajax

В настоящее время я использую комментарии в стиле phpDoc при документировании функций javascript, главным образом потому, что я привык к синтаксису и чувствую, что phpDoc - это хороший, всеобъемлющий стиль комментирования. Одна вещь, которую это не …
11 окт '10 в 09:21
1 ответ

Необычный код Комментарии в Intellij IDEA

Я просматривал код разработчика на GitHub, когда узнал комментарии по центру. Сначала я думал, что кто-то хотел сделать действительно хороший и модный комментарий сегодня, затем я понял, что они использовались во всем проекте. Вот пример того, что я…
30 июн '14 в 18:29
2 ответа

Как вы прокомментируете регулярное выражение Perl?

Как вы помещаете комментарии в регулярное выражение Perl?
11 мар '09 в 00:12
2 ответа

Как создать триггер запроса Auto Pull в AWS CodeCommit?

Я новичок в Code Commit и немного знаю о git. У меня есть root-доступ к репоПо сути, я хочу поддерживать код Commit ветки (master). Я хочу реализовать триггер, (если это возможно), например: Всем разработчикам необходимо создать собственную ветку из…
03 янв '18 в 05:47
0 ответов

VB.NET Как добавить новую строку в документацию класса

Я хотел бы добавить документацию для класса в VB.Net. Я хотел бы добавить несколько примеров и некоторые теги XML в документации класса. Проблема в Object Browser: текст не отформатирован и невозможно перейти на новую строку. Все комментарии в одном…
24 май '18 в 16:01
26 ответов

Каков ваш личный подход / принимать комментарии?

дублировать Каковы ваши жесткие правила комментирования? Разработчик, с которым я работаю, хотел кое-что сказать по поводу комментариев, которые были мне интересны (см. Ниже). Каков ваш личный подход / принимать комментарии? "Я не добавляю комментар…
01 фев '09 в 00:33
2 ответа

Найти несколько комментариев Objective C для файла в определенном формате с помощью Ruby Regex

Я пишу сценарий Ruby, который использует регулярные выражения, чтобы найти все комментарии определенного формата в файлах исходного кода Objective-C. Формат /* <Headline_in_caps> <#>: <Comment body> **/ Я хочу зафиксировать заголов…
20 янв '12 в 19:02
1 ответ

Как быть достаточно конкретным в написании Javadoc

У меня есть вопрос, связанный с написанием стандартных комментариев Javadoc. Они просят нас быть максимально конкретными и использовать предикаты для описания кода, но если у меня есть переменная "d", написанная в моем комментарии, но не указанная в…
09 мар '16 в 20:48
1 ответ

Как написать комментарий в выражении SpEL?

У меня есть выражение Spring Expression Language (SpEL) в атрибуте Thymeleaf. Это становится немного длинным, и часть этого может не быть понятна другим разработчикам, поэтому я хочу включить комментарий в это. Я хочу сделать что-то вроде: T(example…
02 июн '16 в 15:27
2 ответа

Можно ли добавить ссылку или ссылку на метод или свойство?

Я склонен писать довольно много комментариев в рамках одного метода. Время от времени я имею в виду другой метод или свойство в другом классе. Это выглядит примерно так: // если вы раскомментируете следующую строку, убедитесь, что вы отметили 'MyCla…
03 апр '13 в 11:36
2 ответа

Подтвердите, что двоичные файлы сайта ASP.NET не меняются после добавления комментариев в исходный код.

Член моей проектной команды должен добавить комментарии к исходному коду во многие свои проекты ASP.NET, чтобы обеспечить лучшую документацию. Некоторые члены команды проекта рекомендуют проводить тщательное регрессионное тестирование, если мы добав…
02 окт '09 в 19:32
19 ответов

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

Как сохранить исходный код хорошо документированным / прокомментированным? Есть ли инструмент для создания каркаса для комментариев на платформе Unix для C++? В общем, сколько строк комментариев рекомендуется для файла с примерно 100 строками кода?
15 апр '09 в 05:56
1 ответ

Как преобразовать комментарии метаданных в сводные комментарии

Я хочу написать класс-оболочку для набора существующих классов. Когда я иду к определению существующего класса, он показывает файл метаданных с комментариями, такими как // Summary: // This is Test comments Поскольку я пишу класс-обертку, он имеет в…
16 янв '12 в 10:29
1 ответ

Intellij - маркировка блоков кода

Я хочу преобразовать большое количество кода в новые классы. Мне нужен инструмент, который позволит мне пометить части старого кода как "готово", чтобы я мог видеть, что осталось сделать. Я представляю это как некоторые цвета на заднем плане или на …
22 янв '18 в 09:37
2 ответа

Перевод комментариев кода, написанных на другом разговорном языке

Я только что унаследовал некоторый код на C от немецкого программиста, и все комментарии, естественно, на немецком языке. Поскольку я забыл большую часть своего немецкого языка в средней школе, это небольшая проблема. Кто-нибудь знает какие-либо инс…
23 июн '10 в 15:55
1 ответ

Использование комментариев Lint с Doxygen

Для документации нам обычно приходится создавать дополнительный документ, описывающий, что мы делали, когда в коде были отключены любые сообщения lint. (e.g. /* lint --e228), Было бы намного проще использовать его с doxygen (поскольку мы создаем это…
17 янв '13 в 16:55