518
ответов

Каков лучший комментарий в исходном коде, с которым Вы когда-либо встречались? [закрытый]

Каков лучший комментарий в исходном коде, с которым Вы когда-либо встречались?
вопрос задан: 17 September 2011 14:54
90
ответов

Какой наименее полезный комментарий вы когда-либо видели? [закрыто]

Мы все знаем, что комментирование нашего кода является важной частью стиля кодирования, чтобы сделать наш код понятным для следующего человека, который придет, или даже для нас самих через 6 месяцев или около того. Тем не мение, ...
вопрос задан: 23 May 2017 12:09
49
ответов

Что самодокументирует код, и он может заменить хорошо зарегистрированный код? [закрытый]

У меня есть коллега, который настаивает, что для его кода не нужны комментарии, это "сам документирование". Я рассмотрел его код, и в то время как это более ясно, чем код, который я видел, что другие производят, я все еще не соглашаюсь...
вопрос задан: 23 August 2011 06:30
37
ответов

Как убедить людей комментировать свой код [закрыто]

Какие есть веские аргументы, чтобы убедить других прокомментировать свой код? Я заметил, что многие программисты предпочитают воспринимаемую скорость написания кода без комментариев, оставляя некоторую документацию для себя ...
вопрос задан: 23 May 2017 11:44
31
ответ

Нужны ли комментарии для языка программирования?

После некоторых глупых размышлений о языках клингона, которые пришли из этого поста, я начал глупый хобби-проект по созданию языка программирования клингон, который компилируется в байт-код Lua. Во время начального ...
вопрос задан: 23 May 2017 10:29
28
ответов

Комментарий кодирует, который удален [закрытый]

Действительно ли это - хорошая практика для комментария кода, который удален? Например://Код, чтобы сделать {задача} был удален Ajahn 10.10.08 потому что {причина}. Кто-то в моей группе разработчиков во время экспертной оценки, сделанной...
вопрос задан: 5 October 2018 17:22
25
ответов

Есть ли стандартные форматы для комментариев в рамках кода?

Я задаюсь вопросом, есть ли у людей стандартный формат для комментариев в их коде. Не вещи как xml комментирует для метода или класса, а скорее комментариев в рамках метода.См. также: Есть ли стандарт (...
вопрос задан: 23 May 2017 12:18
24
ответа

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

Дубликат, Каковы Ваши твердые правила о комментарии? У Разработчика, с которым я работаю, были некоторые вещи сказать о комментарии, что были интересны мне (см. ниже). Каков Ваш индивидуальный подход/, берут...
вопрос задан: 23 May 2017 12:08
24
ответа

Как сделать комментарии если операторы самый читаемый

Я пытаюсь сделать свой код понятным будущим читателям. У меня всегда были проблемы с тем, как к слову мой, если оператор комментирует для создания его самым понятным. Возможно, это кажется тривиальным, но это...
вопрос задан: 3 June 2009 19:32
24
ответа

Каково золотое отношение кода/комментария? [закрытый]

Существует ли отношение кода/комментария, что Вы считаете знаком хорошего (плохого) здоровья кода? Можно ли дать примеры проектов с открытым исходным кодом, которые считаются хорошо кодированными и их соответствующий комментарий...
вопрос задан: 21 September 2008 19:22
20
ответов

Каковы Ваши “твердые правила” о комментарии Вашего кода?

Я видел другие вопросы, но я все еще не удовлетворен способом, которым покрыт этот предмет. Я хотел бы извлечь дистиллированный список вещей проверить комментарии при инспекции кода. Я...
вопрос задан: 16 January 2018 00:37
19
ответов

Действительно ли возможно написать хороший и понятный код без каких-либо комментариев?

Кто-либо может предложить то, что лучший способ состоит в том, чтобы написать хороший код, который понятен без одной строки комментариев?
вопрос задан: 29 April 2009 19:02
18
ответов

Как Вы отмечаете код так, чтобы можно было возвратиться позже и работать над ним?

В C# я использую #warning и #error директивы, #warning Это грязный код... #error Фиксируют это, прежде чем все взорвется! Таким образом, компилятор сообщит мне, что я все еще должен проделать работу. Что...
вопрос задан: 3 May 2015 02:37
18
ответов

Вы используете специальные комментарии к исправлениям ошибок в Вашем коде?

Некоторые мои коллеги используют специальные комментарии к их исправлениям ошибок, например://23.09.2008 John Doe - ошибка 12345//<краткое описание> это имеет смысл? Вы комментируете исправления ошибок в...
вопрос задан: 24 September 2008 21:32
16
ответов

Обогащенный текст помог бы прокомментировать код? [закрытый]

Я всегда задавался вопросом, почему я должен написать комментариям к коду обогащенного текста иначе псевдо код в текстовом редакторе (c'mon, полужирный, подчеркивание!) и возвращаются к IDE (интегрированный?) для записи фактической программы, не к...
вопрос задан: 22 July 2015 16:45
15
ответов

Вы обновляете древние комментарии к коду, которые являются неправильными? [закрытый]

Хороший день, Вдохновленный комментарием, который я сделал в своем ответе на этот вопрос на комментарии Perl regexps, я задавался вопросом следующее. Когда Вы работаете над более старым, старым, древнее кровавое, код делает Вы обновляете...
вопрос задан: 23 May 2017 12:08
15
ответов

Должны все открытые методы API быть зарегистрированными? [закрытый]

При записи классов типа "библиотеки", это лучшая практика, чтобы всегда записать документацию разметки (т.е. javadoc) в Java или предположить, что код может "самодокументировать"? Например, данный...
вопрос задан: 8 August 2012 19:42
13
ответов

Почему Python не имеет многострочных комментариев?

Хорошо, я знаю, что строки тройных кавычек могут служить многострочными комментариями. Например, """Привет, я - многострочный комментарий""" и '''Привет, я - многострочный комментарий''', Но технически...
вопрос задан: 18 March 2014 18:58
13
ответов

Больше комментариев в коде или просто простом, читаемом, удобном в сопровождении коде достаточно? [закрытый]

Иногда его действительно трудное для выбора, когда точно Вы записали достаточно комментариев для кого-то для понимания намерений. Я думаю, что нужно просто сфокусироваться больше на записи читаемого, легкого к...
вопрос задан: 13 February 2009 13:34
12
ответов

Старый Код в [закрытых] комментариях

Сколько времени необходимо сохранить старый код прокомментированным в кодовой базе? Подрядчики продолжают сохранять старый код в кодовой базе путем превращения его в комментарии. Это действительно печально, и я хочу их к...
вопрос задан: 21 July 2015 16:11
12
ответов

Простой Getter / Setter комментарии

Какое соглашение вы используете, чтобы комментировать геттеры и сеттеры? Это то, что я удивляюсь в течение достаточно долгого времени, например: / ** * (1a), что вы здесь положили? * @парам зарплата (1б), что вы положили ...
вопрос задан: 24 August 2013 01:55
12
ответов

Как Вы разрабатываете главные и незначительные комментарии?

Иногда я хочу записать "главный" комментарий, чтобы описать большой блок кода и затем записать "незначительные" комментарии для описания нескольких строк в том блоке кода://Главный комментарий//Незначительный...
вопрос задан: 1 January 2009 15:06
11
ответов

Комментарии должны показать, какой код версии был добавлен/изменен для полезного?

У некоторых разработчиков на проекте, я продолжаю работать, есть привычка к комментарию их кода для показа, какая версия продукта это было добавлено для, например,//добавленный для строки superEnterpriseyWonder v2.5...
вопрос задан: 6 November 2009 12:29
10
ответов

Какой быстрый способ комментировать / раскомментировать строки в Vim?

У меня есть файл кода Ruby, открытый в vi, есть строки, закомментированные с помощью #: class Search < ActiveRecord :: Migration def self.up # create_table: search do | t | # t.integer: user_id # ...
вопрос задан: 25 December 2013 02:00
10
ответов

Действительно необходимы заголовки комментария и нижние колонтитулы в Вашем коде? [закрытый]

Много корпоративных стандартов кодирования требуют большого заголовка комментария и нижнего колонтитула в каждом файле. Что-то как://MyFile.cpp////Copyright (c) 200x Company ABC////Этот файл...
вопрос задан: 29 August 2012 16:00
10
ответов

Лучшие практики для комментариев управления версиями

Существует большой разговор о комментарии кода, но как насчет того, чтобы комментировать регистрации? Я нашел это сообщение в блоге: http://redbitbluebit.com/subversion-check-in-comment-great-practices/ Как парень...
вопрос задан: 23 June 2011 14:25
9
ответов

Удалить C и комментарии C++ с помощью Python?

Я ищу код Python, который удаляет C и комментарии C++ от строки. (Предположите, что строка содержит весь исходный файл C.) Я понимаю, что мог .match () подстроки с Regex, но что...
вопрос задан: 26 July 2019 03:10
9
ответов

Замените комментарии стиля C комментариев стиля C++

Как я могу автоматически заменить все комментарии стиля C (/* комментарий */) комментариями стиля C++ (//комментарий)? Это должно быть сделано автоматически в нескольких файлах. Любое решение хорошо, пока оно работает....
вопрос задан: 28 August 2018 09:04
9
ответов

Действительно ли это - хорошая практика? “/*/something / */something//*/”

/*/комментарий здесь делает некоторую вещь./*/делают некоторую вещь.//*/, Почему люди пишут код как этот? Действительно ли это - хорошая практика?
вопрос задан: 4 April 2010 15:39
9
ответов

Комментарии влияют на производительность Perl?

Я оптимизирую некоторый часто выполняемый код Perl (однажды в день на файл). Комментарии замедляют сценарии Perl? Мои эксперименты склоняются нет: используйте Сравнительный тест; timethese (20000000, {'комментирует' =>...
вопрос задан: 6 November 2008 23:22