Запитання з тегом «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 …

18 source-code  comments 

Один із розробників моєї команди вважає, що потрібно написати коментар javadoc для параметра КОЖНО у підписі методу. Я не думаю, що це потрібно, і насправді я думаю, що це може бути навіть шкідливим. По-перше, я думаю, що назви параметрів повинні бути описовими та самодокументованими. Якщо не відразу зрозуміло, для чого …

18 java  documentation  source-code  comments  maintainability 

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

17 coding-standards  comments 

У досить деякій кодовій базі ви можете побачити коментарі, в яких зазначається: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Тож у мене є кілька питань, але всі вони пов'язані. Чи правильно розміщувати посилання на питання SO в коментарях до програми: // We're now mapping from the …

16 comments 

Чи вважається поганою практикою кидати NotImplementedExceptionкод, про який ви ще не написали? Можливо, коментарі TODO вважатимуться безпечнішими?

15 .net  comments  coding  exceptions 

Важко сказати, про що тут питають. Це питання є неоднозначним, розпливчастим, неповним, надто широким або риторичним і не може бути обґрунтованим відповіді в його теперішній формі. Для уточнення цього питання, щоб його можна було знову відкрити, відвідайте довідковий центр . Закрито 8 років тому . Я просто з цікавості почав …

15 comments 

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

15 comments 

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

15 c#  documentation  comments 

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

14 version-control  comments  coding-style 

Я пишу багато (в першу чергу c ++ та javascript) коду, який стосується обчислювальної геометрії та графіки та подібних тем, тому я виявив, що візуальні діаграми були невід'ємною частиною процесу вирішення задач. Я зараз вирішив, що "о, чи не було б просто фантастично, якби я міг якось прикріпити мальовану діаграму …

14 productivity  code-reviews  comments  workflows  image-manipulation 

Ми робимо деякий рефакторинг на застарілу базу даних коду, яка триває 20 років, і я веду дискусію з колегою щодо формату коментарів у коді (plsql, java). Формат коментарів за замовчуванням не існує, але в більшості випадків люди роблять щось подібне у коментарі: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy), (author id, …

13 java  c#  programming-practices  code-quality  comments 

Чи гарний стиль використовувати додаткові, технічно зайві, локальні змінні для опису того, що відбувається? Наприклад: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Що стосується технічних витрат, я очікую, що компілятор оптимізує цю додаткову лінію. Але чи вважається це зайвим роздуттям коду? У моїх …

12 coding-style  comments