Вопросы с тегом «comments»

Я ищу рекомендацию лучшей практики для комментариев XML в C #. При создании свойства создается впечатление, что ожидаемая документация XML имеет следующую форму: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. /// </summary> public int ID { get; set; } Но так …

19 c#  .net  programming-practices  comments 

Я видел много номеров выпусков из комментариев кода jQuery . (На самом деле в коде jQuery было 69 номеров выпусков.) Я думаю, что это будет хорошей практикой, но я никогда не видел никаких рекомендаций. Если это хорошая практика, каковы рекомендации для этой практики?

18 comments  issue-tracking 

Насколько я знаю, некоторые делают, но не самые популярные. Есть ли что-то плохое во вложении комментариев? Я планирую разместить блочные комментарии на (маленьком) языке, над которым я работаю, но я хотел бы знать, если это плохая идея.

18 language-agnostic  syntax  comments 

Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Я часто видел такие комментарии: function foo() { ... } // foo while (...) …

18 source-code  comments 

Старший разработчик в нашем магазине настаивает на том, что всякий раз, когда код изменяется, ответственный программист должен добавить встроенный комментарий с указанием того, что он сделал. Эти комментарии обычно выглядят как// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Мы используем TFS для контроля ревизий, и мне кажется, …

17 coding-standards  comments 

Один из разработчиков в моей команде считает, что необходимо написать комментарий javadoc для КАЖДОГО параметра в сигнатуре метода. Я не думаю, что это необходимо, и на самом деле я думаю, что это может быть даже вредно. Прежде всего, я думаю, что имена параметров должны быть описательными и самодокументируемыми. Если не …

17 java  documentation  source-code  comments  maintainability 

В некоторой кодовой базе вы можете видеть комментарии, в которых говорится: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) У меня есть несколько вопросов, но все они связаны. Можно ли поместить ссылку на SO вопросы в комментариях программы: // We're now mapping from the "sorted-on column" to …

16 comments 

Считается ли плохой практикой бросать NotImplementedExceptionкод, который вы еще не написали? Возможно, комментарии TODO будут считаться более безопасными?

15 .net  comments  coding  exceptions 

Трудно сказать, что здесь спрашивают. Этот вопрос является двусмысленным, расплывчатым, неполным, чрезмерно широким или риторическим, и на него нельзя дать разумный ответ в его нынешней форме. Чтобы получить разъяснения по этому вопросу, чтобы его можно было снова открыть, посетите справочный центр . Закрыто 8 лет назад . Просто из любопытства …

15 comments 

В настоящее время этот вопрос не очень подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, вызовет дебаты, споры, опрос или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и, возможно, вновь открыть, обратитесь за …

15 comments 

Рассмотрим маркеры конфликта. то есть: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD В конкретном случае, который побудил меня опубликовать этот вопрос, ответственный член команды только что завершил слияние из основной ветки разработки в нашу ветку и в некоторых случаях оставил их в виде комментариев как своего …

14 version-control  comments  coding-style 

Я пишу много кода (прежде всего с ++ и javascript), который затрагивает вычислительную геометрию и графику и подобные темы, поэтому я обнаружил, что визуальные диаграммы являются неотъемлемой частью процесса решения проблем. Я только что определил, что «о, не было бы просто замечательно, если бы я мог как-то прикрепить нарисованную от …

14 productivity  code-reviews  comments  workflows  image-manipulation 

Я ищу формат документации информативного класса для моих классов Entity, Business Logic и Data Access. Я нашел следующие два формата отсюда Формат 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: …

14 c#  documentation  comments 

Мы проводим рефакторинг 20-летней устаревшей кодовой базы, и я обсуждаю с моим коллегой формат комментариев в коде (plsql, java). Для комментариев нет формата по умолчанию, но в большинстве случаев люди делают что-то подобное в комментарии: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy), (author id, author name, author nickname) and comment Предлагаемый …

13 java  c#  programming-practices  code-quality  comments 

Это хороший стиль, чтобы использовать дополнительные, технически лишние, локальные переменные для описания того, что происходит? Например: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Когда дело доходит до технических накладных расходов, я ожидаю, что компилятор оптимизирует эту дополнительную строку. Но считается ли это ненужным …

12 coding-style  comments