Рассмотрим маркеры конфликта. то есть: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD В конкретном случае, который побудил меня опубликовать этот вопрос, ответственный член команды только что завершил слияние из основной ветки разработки...
Я ищу формат документации информативного класса для моих классов Entity, Business Logic и Data Access. Я нашел следующие два формата отсюда Формат 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> ///...
Я пишу много кода (прежде всего с ++ и javascript), который затрагивает вычислительную геометрию и графику и подобные темы, поэтому я обнаружил, что визуальные диаграммы являются неотъемлемой частью процесса решения проблем. Я только что определил, что «о, не было бы просто замечательно, если бы я...
Мы проводим рефакторинг 20-летней устаревшей кодовой базы, и я обсуждаю с моим коллегой формат комментариев в коде (plsql, java). Для комментариев нет формата по умолчанию, но в большинстве случаев люди делают что-то подобное в комментарии: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy),...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Для комментариев контроля версий, что другие пользователи рекомендуют -...
Это хороший стиль, чтобы использовать дополнительные, технически лишние, локальные переменные для описания того, что происходит? Например: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Когда дело доходит до технических накладных...
У меня довольно большая частная кодовая база, которая развивается уже около десяти лет. Я не использую phpDocumentor, но поскольку использование разделов с докблоком стало довольно стандартным в проектах с открытым исходным кодом, я принял написание докблоков для всех открытых методов в моем...
Существуют ли общие практики для комментирования регулярных выражений: встроенные комментарии, ссылающиеся на различные части RegEx, или общие комментарии для всех...
Я работаю над проектом «спагетти-кода», и пока я исправляю ошибки и внедряю новые функции, я также провожу некоторый рефакторинг, чтобы сделать код модульно-тестируемым. Код часто настолько тесно связан или сложен, что исправление небольшой ошибки приводит к переписыванию множества классов. Поэтому...
Я разговаривал с коллегой сегодня. Мы работаем над кодом для двух разных проектов. В моем случае я единственный человек, работающий над моим кодом; в ее случае несколько человек работают над одной и той же кодовой базой, в том числе студенты-кооператоры, которые приходят и уходят довольно регулярно...
Когда я пишу небольшие сценарии для себя, я складываю свой код с комментариями (иногда я комментирую больше, чем код). Многие люди, с которыми я общаюсь, говорят, что я должен документировать эти сценарии, даже если они являются личными, поэтому, если я когда-нибудь продам их, я буду готов. Но...
Я хотел бы знать, как лучше всего добавить комментарий для идентификации устаревшего класса в Java. Должен ли я удалить предыдущий комментарий, добавленный в начало класса, который помогает другому программисту знать, для чего этот класс, или я должен добавить его под...
Является ли хорошей практикой писать комментарии для широко известных методов, таких как equals, compareTo и т. Д.? Рассмотрим приведенный ниже код. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for...
Я сторонник надлежащим образом документированного кода, и я хорошо осведомлен о возможных его недостатках . Это выходит за рамки этого вопроса. Мне нравится следовать правилу добавления комментариев XML для каждого публичного участника, учитывая, насколько мне нравится IntelliSense в Visual Studio....
Раньше я был поклонником требования XML-комментариев для документации. С тех пор я передумал по двум основным причинам: Как и хороший код, методы должны быть понятны. На практике большинство XML-комментариев представляют собой бесполезный шум, который не дает никакой дополнительной ценности. Много...
Это может быть глупый вопрос, но это было в моей голове некоторое время, и я не могу найти достойного ответа где-либо еще. У меня есть учитель, который говорит, что мы должны явно перечислить каждый параметр с описанием, даже если он только один. Это приводит к большому количеству повторений:...
В настоящее время этот вопрос не очень подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, вызовет дебаты, споры, опрос или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и,...
Я хочу написать Javadoc в сухом виде. Но документ оракула о Javadoc говорит, что напишите то же самое снова в комментарии метода перегрузки. Могу ли я избежать
Я читаю « Чистый код » Роберта С. Мартина, и эта фраза TILTнеобъяснимым образом появляется в некоторых примерах кода. Пример (это на Java, кстати): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT:...
Я собираюсь покинуть проект, и прежде чем я уйду, мой начальник попросил меня документировать код (я не очень хорошо задокументировал). Это не имеет большого значения, проект не очень сложный. Но я нахожу в своей документации места, где я хотел бы сказать: «В строке XYZ обратите внимание, что...