Säännöt koodin kirjoittamiseen (LUE!) - aXu-AP/CoolBasic-Party-Pack GitHub Wiki

Kun ohjelmoidaan ryhmänä, on hyvä, että kaikki kirjoittavat koodia samojen suuntaviivojen mukaisesti. Tässä pieni sääntökokoelma tätä projektia varten:

• Käytä sisennyksiin sarkainta, ei välilyöntejä (cb:n editorissa on asetus Tab lenght: -- Spaces, ota rasti pois). Turha lienee mainita, että sisentäminen on pakollista ;)
• Nimeä kaikki minipelejen käyttöön tarkoitetut nimet (funktiot ja muut globaalit, sisältää myös tyypit) etuliitteellä API_. Sisäiset nimet etuliitteellä MAIN_. Näin on selvää, mitkä toiminnot ovat tarkoitettu mihinkin käyttöön. Ylimääräisten etuliitteiden muistaminen aiheuttaa lähinnä päänvaivaa
• Rivinvaihdot windowsin tapaan (tästä ei tarvitse välittää, jos kirjoitat windowsilla)
• Ääkköset menevät pieleen jos ne on tallennettu eri koodauksella kuin mitä cb käyttää (mikähän lienee?)
• Lisää lyhyt kommentti funktion tehtävästä ja mahdollisesti epäselvistä parametreista riviä ennen funktion määrittämistä (tarkoituksena on jossain vaiheessa laatia ohjelmallisesti dokumentaatio, joten tämä on tärkeää!)
• Kirjoita EndIf, EndFunction jne. yhteen, että esim. haku If:lle tai Endille ei tuota ylimääräisiä tuloksia
• Pyri keksimään muuttujille ja funktioiden parametreille selvät nimet, niin muiden ei tarvitse arvailla käyttötarkoitusta
• Mieti tarkkaan, mihin Includet sijoitat. Pääsääntöisesti kaikki lisätään Main.CB:hen, mutta tiedosto sisältää hyvin erikoistunutta koodia tietyn tehtävän suorittamiseen, liitä include siihen kooditiedostoon, joka sitä käyttää.
• Pyri selvittämään line commenteilla tekemiesi muutoksien syitä (katso committia ja klikkaa kommentoitavan rivin vasemmalla puolella olevaa ikonia)
• Koodi englanniksi, kommentit suomeksi (mistähän tämä tapa on tullut :o)
• Committeja kannattaa tehdä melko useasti, niin että commit messaget ovat selviä. Yritä kuvailla committia yhdellä ytimekkäällä lauseella
• Pull request kannattaa tehdä, kun on saanut jotain toimivaa aikaan

Siinä lienee tärkeimmät... Tietenkin hyvät ohjelmointitottumukset kunniaan!