Запитання з тегом «comments»

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 4 роки тому . Що стосується коментарів щодо контролю версій, що роблять / рекомендують інші користувачі - минулий …

12 comments  source-code 

У мене досить велика приватна база даних коду, яка розвивається вже близько десяти років. Я не використовую phpDocumentor, але оскільки використання розділів docblock стало цілком стандартним для проектів з відкритим кодом, я також прийняв написання docblocks для всіх публічних методів у моєму сховищі. Більшість блоків просто містять невеликий опис та …

12 php  comments 

Я працюю над проектом "спагеті-код", і, поки я виправляю помилки та впроваджую нові функції, я також роблю деякий рефакторинг для того, щоб зробити код блоком-перевіреним. Код часто настільки щільно пов'язаний або складний, що виправлення невеликої помилки призведе до перезапису багатьох класів. Тому я вирішив намалювати рядок десь у коді, де …

11 refactoring  comments 

Чи є загальні практики коментування регулярних виразів: вбудовані коментарі, що стосуються різної частини RegEx, або загальний коментар для всіх виразів?

11 documentation  coding-style  comments 

Я сьогодні спілкувався з колегою. Ми працюємо над кодом для двох різних проектів. У моєму випадку я єдина людина, яка працює над своїм кодом; в її випадку кілька людей працюють над однією кодовою базою, включаючи студентів кооперативів, які приходять і ходять досить регулярно (між кожні 8-12 місяців). Вона сказала, що …

11 coding-style  team  comments 

Я хотів би знати найкращий спосіб додати коментар для визначення застарілого класу на Java. Чи слід видалити попередній коментар, доданий до початку класу, який допомагає іншому програмісту дізнатися, для чого це клас, або я повинен додати його під коментарем?

11 java  code-quality  api  comments 

Коли я пишу невеликі сценарії для себе, я складаю свій код високо з коментарями (іноді я коментую більше, ніж кодую). Дуже багато людей, з якими я розмовляю, кажуть, що мені слід документувати ці сценарії, навіть якщо вони є особистими, так що якщо я коли-небудь їх продаю, я був би готовий. …

11 documentation  comments 

Раніше я любив вимагати коментарів XML для документації. З тих пір я передумав з двох основних причин: Як і хороший код, методи повинні бути зрозумілими. На практиці більшість коментарів XML - це марний шум, який не надає додаткової цінності. Багато разів ми просто використовуємо GhostDoc для генерування загальних коментарів, і …

10 .net  programming-practices  development-process  documentation  comments 

Я прихильник правильно задокументованого коду, і добре знаю можливі його недоліки . Це виходить за межі цього питання. Мені подобається дотримуватися правила додавання коментарів XML для кожного публічного члена, враховуючи, наскільки мені подобається IntelliSense у Visual Studio. Однак є одна форма надмірності, яка турбує навіть надмірного коментаря, як я. Як …

10 documentation  comments  intellisense 

Чи є хорошою практикою писати коментарі до широко відомих методів, таких як рівний, порівнянняДо тощо? Розглянемо наведений нижче код. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for equals } Моя компанія надає …

10 java  comments 

Я читаю " Чистий код " Роберта К. Мартіна, і ця фраза TILTнезрозуміло з'являється в деяких зразках коду. Приклад (до речі, це на Java): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case ErrorCode.MISSING_ARGUMENT: …

9 java  clean-code  comments  conventions 

Я збираюся залишити проект, і перед тим, як поїхати, мій начальник попросив мене документувати код (я не дуже добре документував). Це не велика справа, проект не страшно складний. Але я знаходжу місця в своїй документації, де я хотів би сказати: "Зауважте, на лінії XYZ, що таке і таке трапляється". У …

9 documentation  comments 

Я хочу написати Javadoc сухим способом. Але в документі Oracle про Javadoc сказано написати те саме, що в коментарі методу перевантаження Не можу я уникнути повторення?

9 documentation  comments  dry  javadocs 

Наразі це запитання не підходить для нашого формату запитань. Ми очікуємо, що відповіді будуть підкріплені фактами, посиланнями або експертними знаннями, але це питання, ймовірно, вимагатиме дискусій, аргументів, опитувань чи розширеної дискусії. Якщо ви вважаєте, що це питання можна вдосконалити та, можливо, знову відкрити, відвідайте довідковий центр для ознайомлення . Закрито …

9 comments 

Це може бути дурним питанням, але це вже деякий час у моїй голові, і я ніде більше не можу знайти гідної відповіді. У мене є вчитель, який каже, що ми повинні чітко перелічити кожен параметр з описом, навіть якщо є лише один. Це призводить до великої кількості повторень: double MyFunction(const …

9 documentation  comments  coding-style