Jump to content
php.lv forumi

PHP funkciju komentāri


aaxc

Recommended Posts

  • Replies 57
  • Created
  • Last Reply

Top Posters In This Topic

Top Posters In This Topic

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

Link to comment
Share on other sites

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?

Link to comment
Share on other sites

_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!)

Link to comment
Share on other sites

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.

Link to comment
Share on other sites

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.

Link to comment
Share on other sites

Guest
This topic is now closed to further replies.

×
×
  • Create New...