Вопросы по теме 'comments'
Какой наименее полезный комментарий вы когда-либо видели?
Все мы знаем, что комментирование нашего кода - важная часть стиля кодирования, позволяющая сделать наш код понятным для следующего человека, который придет, или даже для нас самих через 6 месяцев или около того.
Однако иногда комментарий просто не...
29081 просмотров
schedule
29.09.2022
Как в textmate делать комментарии в стиле javadoc, как в eclipse?
В eclipse, когда я хочу задокументировать функцию (в источнике java или javascript), я могу просто ввести / **, затем нажать Enter, и я получаю такой комментарий
/**
*
* Fluctuates all variables to more compatibly foo all the bars
*
* @PARAM...
2219 просмотров
schedule
11.05.2022
Комментирование операторов try catch
Где правильно объяснить обработку ошибок в операторе try-catch? Кажется, вы могли бы поместить поясняющие комментарии либо в начало блока try, либо в блок catch.
// Possible comment location 1
try
{
// real code
}
// Possible comment...
1811 просмотров
schedule
11.06.2022
Как указать типы входных и выходных данных в комментариях Python?
Я видел несколько стандартов написания комментариев о том, какие данные функция ожидает и возвращает в Python. Существует ли консенсус в отношении того, какой из них является наилучшей практикой?
Новая функциональность в...
24668 просмотров
schedule
08.07.2023
Куда помещать комментарии в конструкции if-then-else?
Я никогда не решал, как лучше всего комментировать if-then-else конструкции, поэтому я никогда не стандартизировал последовательный способ их комментирования. Я ценю любые идеи.
Некоторые варианты:
a)
if (blabla) {
// this comment...
9749 просмотров
schedule
28.09.2022
Как заключать в кавычки */ в JavaDocs
Мне нужно включить */ в комментарий JavaDoc. Проблема в том, что это та же самая последовательность для закрытия комментария. Как правильно процитировать/избежать этого?
Пример:
/**
* Returns true if the specified string contains "*/"....
10465 просмотров
schedule
13.01.2023
История изменений в файле
Я работал в нескольких местах, где не использовался контроль версий. Похоже, у них появилась привычка комментировать измененный код, объясняя это изменение, чтобы все можно было отменить.
Я обнаружил, что это делает код очень трудным для чтения, и...
590 просмотров
schedule
29.04.2022
Как сделать комментарии к операторам if наиболее читаемыми
Я пытаюсь сделать мой код понятным для будущих читателей.
У меня всегда были проблемы с тем, как сформулировать комментарии к оператору if, чтобы сделать его наиболее понятным.
Может, это кажется банальным, но меня это всегда беспокоило.
Вот...
1489 просмотров
schedule
02.07.2023
Заставить средство форматирования кода Java Eclipse игнорировать комментарии блоков
Есть ли способ заставить встроенный в Eclipse форматер кода Java игнорировать комментарии? Всякий раз, когда я его запускаю, получается следующее:
/*
* PSEUDOCODE
* Read in user's string/paragraph
*
* Three cases are...
37329 просмотров
schedule
29.07.2022
PHP-скрипт не работает с // комментариями
У меня есть PHP-скрипт, который не работает, если он содержит комментарий типа //. Я имею в виду, что сценарий просто не выполняется за пределами комментария стиля //. Например.
<?php header('Content-type: text/plain');
// some comment
echo...
2278 просмотров
schedule
01.04.2023
XML-комментарии C#: сколько полезных ссылок ‹see /› в XML-комментариях?
В нашей компании мы пишем лишние комментарии Xml. Типичный метод должен быть задокументирован следующим образом:
/// <summary>
/// Determines whether this <see cref="IScheduler"/> contains a specific <see cref="ISchedule"/>.
///...
4887 просмотров
schedule
18.02.2023
Остановить Eclipse от искажения моих комментариев
Есть ли способ остановить затмение от искажения комментариев в моих исходных файлах?
Моя главная проблема - не дать ему обернуть их словами. Мне удалось настроить eclipse так, чтобы он не переносил код на слова, но, похоже, он все еще делает это с...
10172 просмотров
schedule
08.09.2022
Как получить информацию: автор/его комментарии для последней версии Subversion через командную строку?
Я не могу найти этот!
Итак, скажем, кто-то вроде «Джо» (Автор) отправляет свой код в репозиторий svn с сообщением «Исправлена эта ошибка и эта ошибка yada yada» (его комментарии).
Я хотел бы получить через командную строку svn.exe автора и его...
10827 просмотров
schedule
22.06.2022
Как прокомментировать файлы конфигурации Vim: .vimrc?
Как добавить комментарий в файлы конфигурации Vim, например .vimrc?
119082 просмотров
schedule
15.05.2022
Как увеличить длину комментариев таблицы mysql?
Похоже, что максимальная длина комментариев к таблице в mysql составляет всего 60 символов.
Я разрабатываю приложение в php symfony, которое автоматически генерирует предложения sql ddl, и во многих случаях эти комментарии намного превышают 60...
3198 просмотров
schedule
20.04.2022
Замедляют ли комментарии интерпретируемый язык?
Я спрашиваю об этом, потому что использую Python, но это может относиться и к другим интерпретируемым языкам (Ruby, PHP, JavaScript).
Замедляю ли я интерпретатор всякий раз, когда оставляю комментарий в своем коде? Согласно моему ограниченному...
13846 просмотров
schedule
21.06.2022
Комментарии и рейтинг Django
Я ищу систему ведения блогов и комментариев, которая легко интегрируется с моими сайтами Django. Я нашел, что есть много в Сети, и немного потерялся, и у меня нет большого опыта в этом. Надеюсь, вы, ребята, можете дать мне несколько предложений....
1544 просмотров
schedule
03.04.2023
Указание компрессору YUI удалить определенный код без комментариев
В моем javascript у меня есть некоторые фрагменты кода, специально используемые для отладки, которые я не хочу включать в живой сайт. Есть ли способ, которым я могу частично прокомментировать эти фрагменты кода, чтобы они нормально работали как...
1995 просмотров
schedule
28.01.2023
Android Как опубликовать рейтинг/комментарии приложения в Маркете из приложения?
Это простой вопрос. Есть ли способ разрешить пользователям оставлять комментарии и/или оценивать мое приложение непосредственно из моего приложения и публиковать эти данные обратно на Android Market? Если да, то как бы выглядел код для этого, если...
5807 просмотров
schedule
25.10.2022
Использование JQuery для обхода структуры DOM с поиском определенного элемента ‹table›, расположенного после HTML-комментария.
В настоящее время у меня есть исходный код веб-сайта (без контроля над источником), который содержит определенный контент, которым необходимо управлять. На первый взгляд это было бы просто, однако в рассматриваемом теге нет атрибута уникального...
875 просмотров
schedule
18.04.2023
