Courvoisier | Courvoisier the rapidly dwindling sanity of valve programmers as expressed through code comments
Аз не слагам често коментари, но когато слагам са такива.
Бях при едни, искаха всеки Public метод да е с документация. Аз им поспорих, че ако пишем с идеята да се чете, няма да има нужда за който чете, а за който не чете няма да има смисъл и от коментари. Продължихме така половин година. И за ташак пишех
// get pending orders ordered by timestamp ascending GetPendingOrdersByTimestamp // .... // compare two object (hint: icomparable sorting haha) public int CompareTo(MyObject other) { if (IsEqual(other)) return 0; else if (IsGreater(other)) return -1; else return 1; }
Некви такива простотии...
Е, аз пиша доста опън сорс, затова обикновено коментирам публичните функции. Иначе в кода слагам коментари на места където след две месеца, когато съм забравил детайлите ще се чудя какво става. На местата, където правя някаква глупост, защото нямам време/желание да го напиша както трябва задължително слагам някакъв подобен коментар, за да не се чудя след два месеца дали кода има някакъв скрит смисъл. :)