Как обычно обрабатываются комментарии в языках программирования и разметке? Я пишу парсер для некоторого пользовательского языка разметки и хочу следовать принципу наименьшего удивления , поэтому я пытаюсь определить общее соглашение. Например, должен ли комментарий, встроенный в токен, «мешать»...
Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 5 лет назад . Я видел это в SO Tavern , поэтому я размещаю вопрос здесь. Я подумал, что это...
Хотите улучшить этот пост? Предоставьте подробные ответы на этот вопрос, включая цитаты и объяснение того, почему ваш ответ правильный. Ответы без достаточной детализации могут быть отредактированы или удалены. Этот вопрос был перенесен из переполнения стека, потому что на него можно ответить в...
Этот вопрос был перенесен из переполнения стека, потому что на него можно ответить в Software Engineering Stack Exchange. Мигрировал 8 лет назад . Я хочу услышать от вас любые советы и опыт написания комментариев в вашем коде. Как вы пишете их наиболее простым и информативным способом? Какие у вас...
Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Я только начинаю с функционального программирования, и мне интересно, как...
По-видимому, не на одном языке комментарии не могут быть вложенными. У вас есть хорошее решение этой проблемы? Одним из обходных путей в C / C ++ и Java является использование только однострочного комментария, но тогда становится невозможным закомментировать больший блок. Я сталкиваюсь с чем-то...
Locked . Комментарии к этому вопросу были отключены, но он по-прежнему принимает новые ответы и другие взаимодействия. Узнайте больше . У меня был поиск, но я не нашел то, что искал, пожалуйста, не стесняйтесь связать меня, если этот вопрос уже задавался. Ранее в этом месяце было сделано следующее...
Всякий раз, когда я узнаю, что большую часть моего кода необходимо изменить, либо потому, что он некорректен, либо потому, что его нужно адаптировать к серьезным архитектурным изменениям, вызванным другими причинами, я обычно делаю это: Я закомментирую весь код, который, я подозреваю, мне придется...
Комментировать сейчас проще, чем когда-либо. В Java есть несколько хороших методов для привязки комментариев к классам, и Java IDE хороши для создания оболочек комментариев для вас. Такие языки, как Clojure, даже позволяют вам добавить описание функции в сам код функции в качестве аргумента. Однако...
Я ищу рекомендацию лучшей практики для комментариев XML в C #. При создании свойства создается впечатление, что ожидаемая документация XML имеет следующую форму: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. /// </summary> public...
Из некоторых проектов с открытым исходным кодом я собрал следующий стиль кодирования void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Я всегда сомневаюсь, что falseздесь значит. Означает ли это «забыть», или «забыть» относится к соответствующему параметру...
Я видел много номеров выпусков из комментариев кода jQuery . (На самом деле в коде jQuery было 69 номеров выпусков.) Я думаю, что это будет хорошей практикой, но я никогда не видел никаких рекомендаций. Если это хорошая практика, каковы рекомендации для этой...
Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Я часто видел такие комментарии: function foo() { ... } // foo while (...) {...
Насколько я знаю, некоторые делают, но не самые популярные. Есть ли что-то плохое во вложении комментариев? Я планирую разместить блочные комментарии на (маленьком) языке, над которым я работаю, но я хотел бы знать, если это плохая...
Старший разработчик в нашем магазине настаивает на том, что всякий раз, когда код изменяется, ответственный программист должен добавить встроенный комментарий с указанием того, что он сделал. Эти комментарии обычно выглядят как// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Мы...
Один из разработчиков в моей команде считает, что необходимо написать комментарий javadoc для КАЖДОГО параметра в сигнатуре метода. Я не думаю, что это необходимо, и на самом деле я думаю, что это может быть даже вредно. Прежде всего, я думаю, что имена параметров должны быть описательными и...
В некоторой кодовой базе вы можете видеть комментарии, в которых говорится: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) У меня есть несколько вопросов, но все они связаны. Можно ли поместить ссылку на SO вопросы в комментариях программы: // We're now mapping from the...
В настоящее время этот вопрос не очень подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, вызовет дебаты, споры, опрос или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и,...
Считается ли плохой практикой бросать NotImplementedExceptionкод, который вы еще не написали? Возможно, комментарии TODO будут считаться более
Трудно сказать, что здесь спрашивают. Этот вопрос является двусмысленным, расплывчатым, неполным, чрезмерно широким или риторическим, и на него нельзя дать разумный ответ в его нынешней форме. Чтобы получить разъяснения по этому вопросу, чтобы его можно было снова открыть, посетите справочный...