Grey_Wolf Posted July 19, 2012 Report Posted July 19, 2012 Varbūt, bet tad arī savādāk rakstīsi komentārus :D himm.. Tev nesanāk pretrunas? Pats kods lai ir dokumentācija.
daGrevis Posted July 19, 2012 Report Posted July 19, 2012 Kods nav nekāda dokumentācija. Komentāriem ir jāpaskaidro _kāpēc_, bet kods paskaidro _kas_.
Grey_Wolf Posted July 19, 2012 Report Posted July 19, 2012 Kādas tās būtu? vienu brīdi abgalvo: marrtins, on 2012.07.19 13:56, said: Pats kods lai ir dokumentācija. un kad tiek teikts ka komentārus vajaga, arī nelielām f-jam / procedūrām tad : marrtins, on 2012.07.19 20:33, said: Varbūt, bet tad arī savādāk rakstīsi komentārus :D
marrtins Posted July 19, 2012 Report Posted July 19, 2012 (edited) Es zinu, ko es rakstīju, tikai joprojām neredzu, kur ir tava problēma. Edited July 19, 2012 by marrtins
marrtins Posted July 19, 2012 Report Posted July 19, 2012 Komentāriem ir jāpaskaidro _kāpēc_, bet kods paskaidro _kas_. Kāpēc komentāriem būtu jāpaskaidro _kāpēc_? Vai to nedara pasūtītājs? Pat pasūtītājam nevienmēr būtu jāpaskaidro, _kāpēc_ lai kods tiktu rakstits. Kādu _kas_ kods paskaidro?
daGrevis Posted July 19, 2012 Report Posted July 19, 2012 _Kas_ ir _what_. _Kāpēc_ ir _why_. Vai man tev izskaidrot vēl detalizētāk, vai saprati? (Es gatavojos ar meiteni tagad South Park skatīties un ēst Roltonus, tāpēc!)
codez Posted July 19, 2012 Report Posted July 19, 2012 Komentāriem ir jāskaidro ko dara, ja tas nav acīmredzami skaidrs, kā dara, ja tas nav acīmredzami skaidrs un kāpēc dara, ja ir kaut kas, kas nav acīmredzams un pašsaprotams. Tā kā šie visi acīmredzamie ir relatīvi, tad jābūt loģiskai izpratnei par to, cik daudz un dziļi vajag skaidrot.
codez Posted July 19, 2012 Report Posted July 19, 2012 Tas, ka nevajag paskaidrot, ko kods dara ir arī nepareizi. Teiksim, man ir metode, kas ar 30 rindiņām realizē kādu grafu algoritmu, piemēram, topoloģisko kārtošanu, lai sakārtotu atkarīgus darbus to darīšanas secībā. Lai gan 30 rindiņas definē šo algortimu un ko tas dara, tas nav acīmredzami un metodē komentārā der pierakstīt, ka tiek izmantota topoloģiskā kārtošana, lai veiktu darbu sakārtošanu. Var arī pierakstīt kāpēc izmantota tiek topoloģiskā kārtošana, ja ir bijušas kādas citas alternatīvas un apsvērumi.
Recommended Posts