styleguide

jokaisella suurella avoimen lähdekoodin projektilla on oma tyylioppaansa: joukko konventioita(joskus mielivaltaisia) siitä, miten kyseiseen projektiin kirjoitetaan koodia. On paljon vaikeampaa ymmärtää suurta koodibaasia, kun kaikki siinä oleva koodi on yhtenäistä tyyliä.

”Style” kattaa paljon maata: ”use camelCase for variable names”,”never use global variabilities” ja ”never use exceptions.”Tämä projekti (google/styleguide) linkittyy Google code-ohjeisiin, joita käytämme. Jos muokkaat Googlessa alkanutta projektia, voit näyttää tälle sivulle kyseiseen projektiin sovellettavat tyyliohjeet.

tässä projektissa on C++-tyyliopas, C# – tyyliopas,Swift-tyyliopas, Objective-C-tyyliopas,Java-tyyliopas, Python-tyyliopas, R-tyyliopas,Shell-tyyliopas, HTML / CSS-tyyliopas,JavaScript-tyyliopas, TypeScript-tyyliopas, AngularJS-tyyliopas,Common Lisp-tyyliopas ja vimscript-tyyliopas. Tämä hanke sisältää myös cpplint-työkalun, joka auttaa style guide-vaatimusten noudattamisessa,ja google-C-style-ohjelman.el, Emacs asetustiedosto Google style.

Jos projektisi vaatii uuden XML-dokumenttiformaatin luomista, XMLDocument Format Style Guide voi olla hyödyllinen. Lisäksi todellinen stylerules, se sisältää myös neuvoja suunnittelu oman vs. Mukauttaminen existingformat, XML instance asiakirjan muotoilu, ja elementit vs. attribuutteja.

tämän projektin tyylioppaat on lisensoitu CC-By 3.0-lisenssillä,joka kannustaa jakamaan näitä dokumentteja.Lisätietoja https://creativecommons.org/licenses/by/3.0/.

Vastaa

Sähköpostiosoitettasi ei julkaista. Pakolliset kentät on merkitty *