Skocz do zawartości
kebab

SSCC - Standard Skript Code Conventions

Rekomendowane odpowiedzi

Standard Skript Code Conventions

Zbiór zasad dotyczących pisania skryptów, ale nie tylko, gdyż dotyczą ogólnie całego pluginu Skript. Reguły zostały spisane przez: destroyer4017.
Ogólnym założeniem SSCC jest trzymanie ładu w kodzie, jest przez to czytelniejszy i schludniejszy, a do tego łatwiejszy do modyfikowania, poza tym, zapewnia kompatybilność z innymi skryptami.

 

Zapisywanie nazw plików?

Rzecz dość oczywista, jednakże nadmienię iż podczas zapisywania nazwy pliku ze skryptem powinniśmy:

 

  1. Spoiler

     

    1. Nie używać znaków specjalnych, a dokładniej
      #   {}   %   $   `   ,
      a również, co oczywiste, w większości rodzajów rozszerzeń plików etc. - spacji.
    2. W niektórych przypadkach, czyli wymogu dania wersji skryptu w nazwie, umieszczamy ją na końcu nazwy owego pliku, raczej uprzedzonej myślnikiem.

     

     

Utrzymanie ładu w kodzie? Układ poszczególnych rzeczy?

Kolejną również bardzo istotną kwestią jest trzymanie ładu w kodzie, czyli po tym piszemy to a po tym to i tak dalej, przedstawie wam to w postaci listy:

Spoiler

 

  1. script options (dodatek skQuery)
  2. aliasy
  3. zmienne
  4. opcje
  5. funkcje (dodatek skQuery)
  6. zdarzenia - nowe komendy
  7. zdarzenia - on script load: & on script unload: (w takiej kolejności jak tu napisałem)
  8. pętle, zdarzenia na dany okres etc.
  9. inne typy zdarzeń

 

 

Zależności czyli if'y- co i jak?

Bardzo ważna zasada - albowiem błąd, albo po prostu skrócenie popełniane przez większość, nie powinno mieć miejsca, czyli nie stosowanie

Spoiler

 

if

CZYLI:

  • Poprawnie zapisany kod
if clicked block is grass:
  • Niepoprawnie zapisany kod
clicked block is grass:

 

 

 

 

Drugą również ważną zasadą jest skracanie, również popełniane przez więszkość CZYLI:

 

Spoiler

 

  • Poprawnie zapisany kod
on left click:
	if clicker block is grass:
  • Niepoprawnie zapisany kod
    on left click on grass:

 

 

Zapisywanie zmiennych - co i jak?

W przypadku globalnych zmiennych, czyli tych, które obowiązują przez cały kod staramy się stosować do tych reguł, ułatwią one kasowanie, zapisywanie etc., danych w zmiennej

Spoiler
  1.  Aby ułatwić sobie na przykład zmienianie w łatwy sposób zmiennych z innego skryptu, również to co wymieniłem powyżej, powinniśmy stosować takie zmienne:
    {kawa::zmiennaFajna} #dobrze

    zamiast

    {zmienna.fajna} #źle

     

 

 

 

Autorem powyższego tekstu, a dokładniej tłumaczenia jest coffemachine.


ŹRÓDŁO INFORMACJI: http://dev.bukkit.org/bukkit-plugins/skript/forum/tutorials/69108(niestety angielskiej, czyli tej, wersji poradnika już nie ma, ale przy użyciu jakiś timemachine doszukacie się) którego autorem jest destroyer4017, a również inny polski poradnik:

https://skript.pl/temat/1877-standard-skript-code-conventions-r3/#comment-15823

  • Lubię to! 1

Udostępnij tę odpowiedź


Odnośnik do odpowiedzi
Udostępnij na innych stronach
Gość
Ten temat został zamknięty. Brak możliwości dodania odpowiedzi.

  • Ostatnio przeglądający   (0 użytkowników)

    Brak zarejestrowanych użytkowników przeglądających tę stronę.

×
×
  • Dodaj nową pozycję...