turpinājums: no PHP funkciju komentāri

[codez]

 

un ja kāds tomēr ir izdomājis, ka member jātulko kā lietotājs?

Kā viņš var to izdomāt? Tad jau viņš kodā kaut ko salaidis dēlī, jo nezin, kas ir kas.

[marrtins]

lai kods būtu lasāmāk un nebūtu tik daudz jākomentē, varētu darīt šādi:

function sendMessageUser($user_id,$message){
   blabla
}
function sendMessageUserMulti(Array $user_ids,$message){
   loop
   sendMessageUser($user_id, $message);
   /loop
}

Un, ja valoda to atļauj, overloadojam

function sendMessage($users,$message){
   if(is_array($users)){
       loop
       sendMessageUser($user_id, $message);
       /loop
   } elseif(super_struktūra) {
       superojam sendMessageUser
   } else {
       sendMessageUser($user, $message);
   }
}

 

OOP variantā f-iju nosaukumos attiecīgi atmetam vai nu send vai message vai user un variējam parametrus.

Edited July 20, 2012 by marrtins

[y2ok]

Izskatās, ka pašlaik ir neapgāžami fakti -

 

1) Netika pierādīts ar nevienu neapgāžamu argumentu, ka latviešu projektos, kodu ir slikti komentēt latviešu valodā.

 

2) Lietotāja "spainis" totālā izgāšanās.

 

3) http://www.tvnet.lv/zinas/latvija/429789-pieaudzis_sudzibu_skaits_par_valsts_valodas_nelietosanu (kurš maģiski ir tikts izlaists no "par angļu valodas komentāriem" puses).

 

Tā kā laikam var pasludināt 1:0 (par labu komandai "par latviešu valodas komentāriem") dienas beigās.

Edited July 20, 2012 by y2ok

[ieleja]

nu i nez ar to latviešu valodu kodā vispār - gribi kaut ko ātri pielabot ar Far vai MC un hvz kas tur būs latviski vai hieroglifos

[spainis]

Izskatās, ka pašlaik ir neapgāžami fakti -

 

1) Netika pierādīts ar nevienu neapgāžamu argumentu, ka latviešu projektos, kodu ir slikti komentēt latviešu valodā.

 

2) Lietotāja "spainis" totālā izgāšanās.

 

3) http://www.tvnet.lv/...das_nelietosanu (kurš maģiski ir tikts izlaists no "par angļu valodas komentāriem" puses).

 

Tā kā laikam var pasludināt 1:0 (par labu komandai "par latviešu valodas komentāriem") dienas beigās.

 

[blackhalt]

Ja kāds tagad vēl atceras PSRS laika latviešu pārkrievošanu, tad sapratīs šodienas latviešu pārangliskošanu.

 

btw http://lv.wikipedia.org/wiki/Esperanto ;)

[Mr.Key]

Programmētāja darba valoda *pasaulē* ir angļu valoda. Ja sagādā grūtības izteikties, tad der iemācīties angļu valodu. Piemēram, artikulu pareiza lietošana var nest daudzas atziņas, kā ar mazliet atšķirīgiem teikumiem var izteikt pilnīgi atšķirīgas domas. Un latv. valodas aizstāvjiem, ko teiksiet par komentāriem "Fiksēta problēma X" (vai problēma ir izlabota, jeb, tieši otrādi, fiksēta tā, ka nevar izlabot?), "Uzsetoti opciju parametri" (uz-se-kas? teniss?), utml.? Tie vēl tādi maigi piemēri...

 

Es komentārus veidoju angliski, jo, papildus tam, ka rakstot angliski nav jātērē enerģija terminoloģijas tulkošanai, tas arī palīdz sagatavoties situācijām kad jastrādā EN projektā vai projektā tiek iesaistīti !LV cilvēki. Starp citu, tas var izskatīties arī tā, ka jums lūdz parādīt koda piemēru un lūdzēji ir, piemēram, Skype Igaunijā u.tml.

 

Protams, ka tas neliedz rakstīt komentārus un dokumentāciju latviešu valodā, ja ilgtermiņā tas sevi attaisno *un* ja tas tiek darīts gramatiski pareizi, lietojot pareizus LV terminus (termini.lza.lv, termini.lv). Ja dokuments vai komentārs atgādina rasolu, kur LV sarunvaloda sajaukta kopā ar EN terminiem ar pielīmētām latviešu val. galotnēm, tad tas patiesībā iedarbojas pretēji - vismaz es tādu latviešu valodu nevēlos redzēt.

 

P.S. Šobrīd lasu labu, programmēšanas TOP grāmatu,.kurā skaisti pateikts - cilvēks spēj izteikt savu domu tad, ja pārzin vārdus, ar kuriem to izteikt. Pretējā gadījumā nekāda domu izteikšana nesanāk, jo vienkārši to nevar salikt saprotamā valodā. Tas attiecas gan uz angļu valodu kā komentāru valodu, gan programmēšanu vispār.

Edited July 21, 2012 by Mr.Key

[e-remit]

Pēc idejas, nav jau nekur stingri rakstīts, kā ir pareizi darīt. Galvenās vadlīnijas - biznesa prasību ievērošana (piemēram, projekta prasības rakstīt komentārus dokumentācijas ģenerēšanai) un parūpēšanās par sevi un pēctečiem, lai saprastu, kas kodā ir veidots.

Pašam pašlaik sanāk strādāt pie projektiem, kurus izstrādā daži LV programmētāji, pārskatāmā nākotnē ārzemnieki projektus nepārņems. Tad nu komentārus rakstu skaidrā latviešu valodā, jo man ir interese, lai mani kolēģi saprastu, kāda iksa pēc ir rakstīts šādi, kā arī, lai IDE atrādītu metožu parametru aprakstus, tas palīdz labāk uz rakstāmo kodu koncentrēties.

Ir arī bijuši projekti, kur komentāri ir angliski, jo kodu lasīs arī ne-LV programmētāji, un ir mazi projektiņi, kur tiešām komentārus slinkums rakstīt.

Situācijas ir dažādas, tāpēc visi "ir jādara tieši tā" vienkārši nestrādā. (Jebkuršs vispārinājums ir kļūdains, ieskaitot šo...)

[Grey_Wolf]

. Un latv. valodas aizstāvjiem, ko teiksiet par komentāriem "Fiksēta problēma X" (vai problēma ir izlabota, jeb, tieši otrādi, fiksēta tā, ka nevar izlabot?), "Uzsetoti opciju parametri" (uz-se-kas? teniss?), utml.? Tie vēl tādi maigi piemēri...

runa bija ka rakstīt Latviešu valodā, nevis žargonā..

Fiksēta problēma X" ->

---

Problēma x izlabota

problēma X nav izlabota, jo Y

šeit ir problēma X, kuru jaizlabo ...

--

Komentāram PREZCĪZI jānorāda kas ir kas, jo savādāk no viņa zūd jēga..

P.S. debīlu komentāru var uzrakstīt jebkurā valodā

[daGrevis]

Tu komentāros raksti to, ko tu esi izlabojis?!

[y2ok]

daGrevis, Grey_wolf piemēri bija atbilde uz Mr. Key jautājumu :).

[codez]

Es gan neesmu rakstīji, bet citos opensource projektos esmu redzējis komentāru, ka šis ir fix tādam un tādam issue, jo rakstīt visu issue būtību, kura var būt iztirzāta pārdesmit komentāros nebūtu prātīgi, tāpēc pieraksta tikai fixed: issue 444 un kam vajadzēs, pasaktīsies issue trackerī, lai saprastu kāpēc ir veikts šāds labojums.

[Grey_Wolf]

Tu komentāros raksti to, ko tu esi izlabojis?!

vispār dažreiz tiek pierakstīts , lai citi saprastu kas ir ticis izmainīts...

 

 

 

lai kods būtu lasāmāk un nebūtu tik daudz jākomentē, varētu darīt šādi:

function sendMessageUser($user_id,$message){
   blabla
}
function sendMessageUserMulti(Array $user_ids,$message){
   loop
   sendMessageUser($user_id, $message);
   /loop
}

hmm .. Ja šāds ieteikums nāk tikai pēc tik garas diskusijas , tad rodas jautājums ka tu rakstiji f-ju nosaukumus līdz šim ?

Edited July 22, 2012 by Grey_Wolf

[marrtins]

Koa? o_O