FIGYELEM! A MicroCoinnak és a fejlesztő csapatának nincs köze a Mikron nevű ICO-hoz!

Kódolási stílusok

Innen: MicroCoin Wiki

Ne feledd, ha valamit elrontasz elvesztheted az összes MicroCoinod. Soha ne fejlessz Mainnet-en és mindig gondolkodj felelősségteljesen!

Miért van szükség a szabályokra?

Azért, hogy karbantartható és átlátható legyen a kódbázisunk szükségünk van szabályokra, amelyeket minden fejlesztőnek be kell tartania. A szabályok csak az újonnan létrhozott és a módosított kódokra érvényes.

Szabályok pascal nyelven

Pascal nyelven a következők betartására kérünk:

Elnevezési szabályok

  • A változókat, típusokat, eljárásokat és függvényeket angolul nevezzük el
  • Használj beszédes neveket
  • Lokális változók esetén használj x prefixet (pl. xName, xKey)
  • Ciklusváltozók esetén használd az i,j,k... betűket
  • Az osztályok esetén használj T prefixet
  • A megfelelő névtérbe tedd a kódod
  • A konstansok esetén használj c prefixet (pl. cMagic)
  • Tagold a kódot, TAB helyett használj szóközöket

Kódolási szabályok

  • Ahol lehet, ott kerüld a Streameket
  • Lehetőség szerint minél kevesebb memóriát használj
  • Mindig szabadítsd fel a lefoglalt memóriát (ügyelj a stringekre főleg a rekordokban!)
  • Használd a FastMM debug funkcióit
  • Ne módosíts olyan kódot amelyet nem értesz teljes bizonyossággal

Tervezési szabályok

  • Mindig választ el a GUI-t és az üzleti logikát
  • Az adatok és entitások definíciót különítsd el
  • Gondolkodj platformfüggetlen módon

Licensz és fejléc

Pascal kódok esetén MIT License alatt publikáljuk a kódot és erre téged is megkérünk.

Új fájl esetén

Ha úgy fájlt hozol létre amelyben csak a te kódod kerül használd a következő fejlécet:

{==============================================================================|
| MicroCoin                                                                    |
| Copyright (c) 2017-2018 Ide írd a Te neved                                   |
|==============================================================================|
| Permission is hereby granted, free of charge, to any person obtaining a copy |
| of this software and associated documentation files (the "Software"), to     |
| deal in the Software without restriction, including without limitation the   |
| rights to use, copy, modify, merge, publish, distribute, sublicense, and/or  |
| sell opies of the Software, and to permit persons to whom the Software is    |
| furnished to do so, subject to the following conditions:                     |
|                                                                              |
| The above copyright notice and this permission notice shall be included in   |
| all copies or substantial portions of the Software.                          |
|------------------------------------------------------------------------------|
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR   |
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,     |
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  |
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       |
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING      |
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER          |
| DEALINGS IN THE SOFTWARE.                                                    |
|==============================================================================|
| File:       IDE IRD A FÁJL NEVÉT                                             |
| Created at: DÁTUM                                                            |
| Purpose:    ÍRD LE RÖVIDEN MIRE SZOLGÁL EZ A KÓD                             |
|==============================================================================}

Ha módosítasz egy meglévő fájlt

Ebben az esetben írd be a fejléc alsó részébe a Copyright-od és, hogy mit módosítottál, pl:

{...
|==============================================================================|
| File:       MicroCoin.Transaction.Transaction.pas                            |
| Created at: 2018-09-04                                                       |
| Purpose:    Base class for transactions                                      |
|==============================================================================|
| Copyright (c) DÁTUM NEVED                                                    |
| Fixed Access violation when the account name is empty                        |
|==============================================================================}

Ha kisebb részeket felhasználsz nem MicroCoin-os fejléccel rendelkező fájlokból

Ebben az esetben ne feledd el megemlíteni a szerzőket, példa:

{...
|==============================================================================|
| This unit contains portions from PascalCoin                                  |
| Copyright (c) Albert Molina 2016 - 2018                                      |
|                                                                              |
| Distributed under the MIT software license, see the accompanying file        |
| LICENSE or visit http://www.opensource.org/licenses/mit-license.php.         |
|==============================================================================|
| File:       MicroCoin.Transaction.Transaction.pas                            |
| Created at: 2018-09-04                                                       |
| Purpose:    Base class for transactions                                      |
|==============================================================================}