V kakšnem stilu pišete vašo kodo?

showsover je 27. dec 2020 ob 10:56 izjavil:

public class SomeClass
 {
 // pripravim parametre ---- ???
 int i = ...
 // grem iskat podatke v tabelo ---- ???
 TableRead(...
 // validacija ---- ???
 Validate(...
 }

Hehe, močno upam, da tile "---- ???" so samo primer nekega splošnega, ker so te stvari self-evident, če so variable/funkcije/metode/... smiselno poimenovani. Verjetno pa ne pričakujemo, da bo za nami kodo bral nekdo, ki mu te stvari niso kristalno jasne iz aviona. Ali??

Meni ti komentarji delujejo povsem odvec.



@WizzdardOfOz

/// <summary>
/// nabor podatkov iz tabele
/// osnovni zahtevek: 1234, osnovni nabor podatkov za validacijo, dne: 12.12.2020, kdo: nebivedu
/// popravek po zahtevku: 1235, spremenjeni parametri za nabor podatkov, dne: 15:12:2020, kdo: mr_chai
/// popravek po zahtevku: 1345, dodan parameter xxx zaradi validacije, dne: 17:12:2020, kdo: nebivedu
/// </summary>
public class SomeClass
{
  // pripravim parametre
  int i = ...
  // grem iskat podatke v tabelo
  TableRead(...
  // validacija
  Validate(...
}

A je to dejansko potrebno? A nima IDE kak version compare, kjer jasno kaze, kaj je bilo spremenjeno od zadnje verzije ter od koga? Sicer ni nic narobe, da se v komentar napise, stevilka zahtevka. Ampak bi to napisal direktno nad vrstico, kjer je bil nov del kode zapisan in ne na zacetku metode, kjer moraš potem ugibat, kje točno je bila sprememba narejena.

FTad je 27. dec 2020 ob 11:02 izjavil:

A je to dejansko potrebno? A nima IDE kak version compare, kjer jasno kaze, kaj je bilo spremenjeno od zadnje verzije ter od koga? Sicer ni nic narobe, da se v komentar napise, stevilka zahtevka. Ampak bi to napisal direktno nad vrstico, kjer je bil nov del kode zapisan in ne na zacetku metode, kjer moraš potem ugibat, kje točno je bila sprememba narejena.

Ko te čez več let vprašajo, zakaj tako in zakaj ne drugače, jim lahko takoj poveš kje je bilo točno to zahtevano. Se mi je že zgodilo, da so po 19ih (devetnajstih) letih prišli težit, da nekaj dela v mojem programu narobe. Po pregledu kode, smo prišli do dokumentacije korakov, kjer je bilo zapisano kdo je zahteval in zakaj je zahteval (in to ravno oseba, ki je po 19 letih prišla težiti), sem imel alibi. Drugače bi me pa po zobeh vlačili. Sem namreč delal v takem kolektivu, kjer si za napake drugih ti odgovarjal, če nisi imel črno na belem zakaj in kako.


Kodo za primer sem vzel za C#, ker večina to najbolj razume, pa zelo lepo se jo da napisat pregledno. Komentarjev v vsaki vrstici res ne rabiš, jih dajem samo, če je kakšna resna posebnost. V primeru sem jih pa dal, da se bolje vidi.
Jaz sicer programiram poleg .net, tudi še v dosti drugih jezikih (Cobol, Rexx, Assembler, ...) in vsi takih komentarjev nimajo. Poleg tega je lahko problematično verzioniranje, itd. Ampak če bi tisto kodo napisal, jih večina nebi vedla za kaj gre.
Recimo:

; kontrola semforja z 8086 mikroprocesorjem 

   #start=Semafor.exe#

   name "promet"


   mov ax, all_red
   out 4, ax


   mov si, offset situation


   next:
   mov ax, [si]
   out 4, ax

   ; wait 5 seconds (5 million microseconds) 
   mov     cx, 4Ch    ;    004C4B40h = 5,000,000 
   mov     dx, 4B40h
   mov     ah, 86h
   int     15h


   add si, 2 ; next situation 
   cmp si, sit_end
   jb  next
   mov si, offset situation
   jmp next

   ;                        FEDC_BA98_7654_3210 
   situation        dw      0000_0011_0000_1100b
   s1               dw      0000_0110_1001_1010b
   s2               dw      0000_1000_0110_0001b
   s3               dw      0000_1000_0110_0001b
   s4               dw      0000_0100_1101_0011b
   sit_end = $


   all_red          equ     0000_0010_0100_1001b

Je pa v mojem programskem jeziku prvih 8 znakov lahko datum. In v komentarju je na teh prvih osmih mestih tudi datum.

Torej nekako tako:

20201212   koda programja
20201215   koda programja

Smisel komentiranja npr bloka spremnljivk je samo večja preglednost. Da lahko bolj hitro preskočiš tisti blok kode z očmi. Vidiš komentar, niti ne gledaš vse spremenljivk, in si lahko brez skrbi, da v tistem bloku ni nič zanimivega in greš dalje brati bolj zanimive dele. Ravno zaradi tega razloga je bolj pametno deklaracijo spremenljivk dati vse na vrh funkcije, da ne smetijo kode. Tako je ostala pomembna koda čimmanjša, kar pripomore k hitrejšemu razumevanju.

Sem pa bil enkrat na razgovoru in rekel unemu loleku, da kodo ločim na bloke. Ravno tako bebasto me je gledal kot vi zdajle in me seveda najbrž ravno zaradi tega mojega komnetarja ni vzel v službo. Še bolje, takih ljudi ne rabim gledat, s katerimi nismo na isti valovni dolžini.

Sem pa bil enkrat na razgovoru in rekel unemu loleku, da kodo ločim na bloke. Ravno tako bebasto me je gledal kot vi zdajle in me seveda najbrž ravno zaradi tega mojega komnetarja ni vzel v službo. Še bolje, takih ljudi ne rabim gledat, s katerimi nismo na isti valovni dolžini.

You really don't get the clues, don't you?

Ego ti ne dovoli, da vidiš jasno sliko, kaj se s tem dogaja. Sedaj imaš že nekaj vzorcev, zakaj misliš da bo naslednjič rezultat istega vzorca drugačen? Tvoj ego je tisti, ki ne dovoli da bi sprejel drugo mnenje (in to da se motiš), ter prišel na isto "valovno dolžino" kot drugi in si tako izboljšal možnosti za uspeh, kar posledično zavira tvoj razvoj.

shadeX je 27. dec 2020 ob 15:02 izjavil:

Tvoj ego je tisti, ki ne dovoli da bi sprejel drugo mnenje (in to da se motiš), ter prišel na isto "valovno dolžino" kot drugi in si tako izboljšal možnosti za uspeh, kar posledično zavira tvoj razvoj.

Moj razvoj gre čist ok ne skrbi zame. Sem našel ljudi, s katerimi smo na isti valovni dolžini.
Saj jaz sem tukaj, da se kaj naučim od vas. Še vedno čakam... Do zdaj sem vas moral jaz učiti, od vas sem nazaj dobival samo neko zgražanje brez razloga.

Moj razvoj gre čist ok ne skrbi zame.

In po kakšnih kriterijih ti to ocenjuješ? Kdaj veš, kdaj se tvoj razvoj ustavi oz. kaj ga zavira?

Sem našel ljudi, s katerimi smo na isti valovni dolžini.

Sej ravno to je narobe. "If you're the smartest person in the room, you're in the wrong room. - Lorne Michaels"

Saj jaz sem tukaj, da se kaj naučim od vas

Če se hočeš naučiti, boš moral začeti sprejemat mnenje, ki je drugačno od svojega in vzeti v zakup da ima tudi drugi lahko prav, sploh kadar je toliko indicev, da so verjetnosti da imaš ti prav smešno nizke.

kuall je 27. dec 2020 ob 15:20 izjavil:

Jaz sem čist sposoben priznat, da sem prvič slišal za TECHNICAL DEBT. Pa mi gre brez tega znanja čist ok, ne mislim se začet učit teh stvari, ker jih ne rabim, me ne zanimajo.

Tist debt je sam en primer, ki sem se ga spomnil. Ko sem se sledil debato z ostalimi sem tudi videl, da morda se kake druge stvari ne razumes cisto dobro ali pa se sam ne znas dobro izrazit.

kuall je 27. dec 2020 ob 15:20 izjavil:

Me pa čudi, da ti nečesa ne veš heh.

Ne vem kaj naj bo to pomenilo ... vsekakor dost stvari ne vem, zadnje leto sem tudi bolj v management vodah in mogoce ne sledim toliko trendom.

kuall je 27. dec 2020 ob 15:20 izjavil:

Rast plače je že dober pokazatelj.

Rast place je lahko tudi samo posledica sistematizacije delovnih mest ali pa usklajevanje.

Povsem tehnicno vprasanje. Cemu nisi spremenljivke raje poimenoval date_start, ali pa datetime_start? Res da je funkcija kratka, ampak bi imo še za malenkost pohitrila razumevanje le te.


V osnovi gre za dvojni klik na be_se_do, ki je ločena z podčrtaji:

- v bluefish (html/css/js) izbere zgolj besedo in se ustavi pri podčrtaju (be_se_do)
- v pycharm (python) izbere celotno besedo (be_se_do)


In potem skačem iz enega v drugega. Če pridem iz bluefish v pycharm, mi ni do podčrtajev. Če pridem iz pycharm v bluefish, so mi podčrtaji kul. Na koncu je nastal en mal hlev s temi podčrtaji.

In je moteče, če je treba z miško označit celoten tekst, od začetka do konca (ali pa da se postaviš na konec, in potem ctrl+shift+levo). Je hitreje dvoklik.


Itak je pa več možnih zapisov:

funkcija getDate()
funckija GetDate()
funckija get_date()
funkcija getdate()


V JS pišem funkcije vse z malo, nekatere daljše s podčrtajom:
getdate()
get_something_and_convert_to_int()



V Pythonu pa sem začel poimenovat po sklopih, s podčrtaji ločim le prvi del, uporablja se tudi velika začetnica (razen za helper funkcije):

Helper: getdate(), gettime(), logging(), debugging()
(prva dva vračata string, druga dva vpisujeta string v log/debug file)

File system: FS_ReadFileIntoQueueItem(), FS_DeleteQueueItem()
(branje in zapisovanje v/iz queue)

Maria db: MDB_DoesShopProductComboExist(), MDB_InsertItem()
(branje/pisanje z bazo)

Http get: GET_DownloadImage()
(network komunikacija)

PIL: PIL_MakeThumbnailPicture()
(delo s slikami)

Threading: THR_IsAnotherThreadRunning()
(ne gre za taprav threading (prav bi bilo process, ampak sem uporabil trhead. that's one of thoes...),
ampak za to, da z popen odpiram en in ist process, večkrat, le-ta pa se bo štartal,
če trenutno že ne laufa tak process. se prav, da je vedno single mode...)

Processes: PROC_ProcessQueueFiles()
(processes so na začetku, v main-u, kjer se odloča, kater (večji) del kode oz. veje se bo poganjalo)


V Maria DB pa procedure poimenujem tako:

SP_DoesShopProductComboExist



To je to.

@HotBurek

hvala za pojasnilo. Navajen sem na sintakso in "guidlines" za programiranje v ABAP-u, pa pozabljam, da je v drugih jezikih malenkost drugace. Npr v ABAPu ne moremo kombinirati velikih in malih crk ala getData(), ker ti glede na nastavitev ukaze vse zapise z velikimi ali maliim crkami.

Ce imas vecje stevilo metod, ki se nanasajo na nekaj podobnega kot je tukaj HWState je za razmisliti, ce ni vredno naresti posebnega classa za tole (ampak v bistvu je precej odvisno od primer do primera). Osebno tudi ne maram mesanje camelcase s podcrtaji.

Ce tebe ne zanima praksa dobrega pisanja kode, se ne pomeni da koga drugega ne. Nenazadnje je prav ta tema namenjena temu, za razliko od tvojih custvenih izpovedih o sefih.

@Smurf: ja, ce jih je veliko se splaca. Ce jih je pa obvladljivo stevilo, hkrati pa potrebujejo 'intimno' poznavanje classa, lahko po mojem mnenju ostanejo tako, kot je v mojem primeru.
@BigWhale: tako je, potrebno je uporabiti enak slog, kot ostali na projektu oz. v podjetju. Najgrse je, ko naletis na kaksno legacy kodo, kjer so vsi stili med sabo pomesani.

Obicajno imajo ekipe nek coding guidelines in je tam notri opisan stil kodiranja. Kar je super, ker zagotavlja enostnost kode, vendar ni nujno, da je ta guideline tudi napisan po dobrih praksah. Ce so v tem guideline slabe prakse, se zagotovo splaca se uskladiti z vodjo ekipe/oddelka.

Jirzy je 28. dec 2020 ob 08:39 izjavil:

Jaz pisem tako, kot imamo definirano v podjetju - za C++ CamelCase, za python camelCase.
Ce pa imam kje vecje stevilo metod, ki pocnejo sorodno stvar, jih dodatno oznacim z _.

Kot omenjeno, tudi jaz bi svetoval (za napisan primer), da naredis nek class in pod njim spises sorodne metode.

/// <summary>
/// nabor podatkov iz tabele
/// osnovni zahtevek: 1234, osnovni nabor podatkov za validacijo, dne: 12.12.2020, kdo: nebivedu
/// popravek po zahtevku: 1235, spremenjeni parametri za nabor podatkov, dne: 15:12:2020, kdo: mr_chai
/// popravek po zahtevku: 1345, dodan parameter xxx zaradi validacije, dne: 17:12:2020, kdo: nebivedu
/// </summary>
public class SomeClass
{
  // pripravim parametre
  int i = ...
  // grem iskat podatke v tabelo
  TableRead(...
  // validacija
  Validate(...
}

Tile komentarji sprememb so uporabni samo tam, kjer ni gita ali alternative. Drugace je to ena izmed najbolj neuporabnih zadev kar je mozno. Git je narejen za to. Zaradi mene lahko poleg commit messaga v git daste se link do svojega bug trackerja pa bo veliko bolje kot tole. A sploh kdaj generirate dokumentacijo in jo posljete zunanjim strankam? A so navduseni, ko to prebirajo?
Cemu se vedno na vrhu funkcije definirate parametre? Ok so jeziki kjer to moras naredit ampak nisem preprican, da tale spada mednje. Definiras cim blizje ko potrebujes. S tem povecas preglednost in zmanjsas moznost napak.

Ne tega jemat kot nek posrečen primer, če gre (res) za class, je že ime polja i neustrezno, lastnosti morda res ni, vse prikazane metode so tipa void itd. To je bilo zagotovo dano samo za res osnovno ilustracijo...

Ne glede na jezik, brez VC nimas popolnoma nobenega nadzora, kdaj in od kje je zadeva prisla. Se pa strinjam, da je vsaj za assembler (cobol-a in rexx-a ne poznam) potrebno precej bolj komentirati, ker ni tako razumljiva koda.

FTad je 28. dec 2020 ob 13:33 izjavil:

Pa se v tem primeru splača pisati posebej class?

1. Se bodo tiste metode uporabljale tudi kje drugje?
2. Je za pričakovati, da se lahko znotraj tega classa poveča število metod, da se upraviči pisanje posebej classa?
3. Bi se splačalo pisati posebej class, če bi imeli samo 2 metodi in niti ne veste, če bi ju lahko uporabili kasneje v kakem drugem programu?
3.a. ali šele kasneje, ko pridete do take situacije, iz teh funkcij napisete class, vstavite metode in potem zamenjate funkcije s klici teh metod?

To sprašujem čisto resno, saj me zanima, kako oz na podlagi kakšnih izkušenj se odločate iz takih situacij pisati posebej class.

Število metod (ali propertijev) v bistvu sploh ni pomembno. Včasih ima class lahko samo eno metodo, včasih je lahko celo prazen.

Tudi kolikokrat se uporablja, samo po sebi ni kriterij.

Kriteriji so bolj:
- za kaj se uporablja
- kako se uporablja
- preglednost
- dokumentacija
- testiranje
- ...

Mainframe je ovira, pa njegov file system in povezave. Dela se namreč direktno preko terminala v VMS (virtual memory system).

darkolord je 28. dec 2020 ob 14:25 izjavil:

FTad je 28. dec 2020 ob 13:33 izjavil:

Pa se v tem primeru splača pisati posebej class?

1. Se bodo tiste metode uporabljale tudi kje drugje?
2. Je za pričakovati, da se lahko znotraj tega classa poveča število metod, da se upraviči pisanje posebej classa?
3. Bi se splačalo pisati posebej class, če bi imeli samo 2 metodi in niti ne veste, če bi ju lahko uporabili kasneje v kakem drugem programu?
3.a. ali šele kasneje, ko pridete do take situacije, iz teh funkcij napisete class, vstavite metode in potem zamenjate funkcije s klici teh metod?

To sprašujem čisto resno, saj me zanima, kako oz na podlagi kakšnih izkušenj se odločate iz takih situacij pisati posebej class.

Število metod (ali propertijev) v bistvu sploh ni pomembno. Včasih ima class lahko samo eno metodo, včasih je lahko celo prazen.

Tudi kolikokrat se uporablja, samo po sebi ni kriterij.

Kriteriji so bolj:
- za kaj se uporablja
- kako se uporablja
- preglednost
- dokumentacija
- testiranje
- ...

Spet. So jeziki, kjer je uporaba classa nujna kot je java. Nekje jih ni kot v c. Nekje je mesanica kot v c++. Zakaj bi v c++ vse tiscal v class mi ni jasno. To je v celoti odvisno od uporabe...

Vcasih preprosto in kmecko, komajda DRY - takrat ima vsakdo nekaj za pripomniti na pull requestih, vcasih pa fancy z jakimi naprednimi pristopi, takrat vsi samo slepo potrdijo pull request ocarani od njene lepote.

Uganite, kaj dela 100x bolje in mi pozre manj casa v prihodnje...

Jaz podvajam kodo? Nekaj novega sem se pa naučil od vas.

kuall je 28. dec 2020 ob 17:15 izjavil:

Jaz podvajam kodo? Nekaj novega sem se pa naučil od vas.

Ne. Po nepotrebnem podvajas izvajanje kode.

Linux je nekaj drugega kot ZOS. Če delaš na linux particijah na mainframeu imaš ogromno več možnosti.
Delaš pa lahko tudi v IDE, ampak je hitreje direkt v konzoli. Parkrat hitreje. Vsaj zame.

SloKin je 28. dec 2020 ob 13:34 izjavil:

Cemu se vedno na vrhu funkcije definirate parametre? Ok so jeziki kjer to moras naredit ampak nisem preprican, da tale spada mednje. Definiras cim blizje ko potrebujes. S tem povecas preglednost in zmanjsas moznost napak.

Se popolnoma strinjam in tudi sam programiram na ta način.

WizzardOfOZ je 28. dec 2020 ob 20:22 izjavil:

Linux je nekaj drugega kot ZOS. Če delaš na linux particijah na mainframeu imaš ogromno več možnosti.
Delaš pa lahko tudi v IDE, ampak je hitreje direkt v konzoli. Parkrat hitreje. Vsaj zame.

Narobe si me razumel. :) Velik stvari je blo treba narest tud na samih VSMjih in napisat en kup toolinga, pa smo vseeno imel proper version control. Delanje direkt v konzoli in izgovor, da gre tko velik hitrejs je sam izgovor za narobe postavljeno produkcijo. Na zalost.

kuall je 28. dec 2020 ob 21:43 izjavil:

Dej mi tvoj gitgub account, da ti pokažem primer, kako se da tvoje špageti funkcije polepšat z logičnim segmentiranjem. Ali boš rekel, da imaš samo funkcije s 5 vrsticami?

Tud tvoj github account se cakamo... :>