Kódolási konvenciók és a .editorconfig

Ha egy projekten egynél több ember dolgozik, akkor a kódolási konvenciók megléte egy projekt esetén mondhatni kulcsfontosságú. A jól összerakott konvenciók és azok betartása segíti a kód karbantarthatóságát. A projekten kialakított konvenció akkor jó, ha kellően megengedő és szigorú egyben.

Ez elsőre ellentmondásnak tűnhet, de ha belegondolunk, akkor logikus. Kellően engedékeny, hogy ne érezzük nyűgnek, de kellően szigorú a kulcsfontosságú kérdésekben.

Kérdés az, hogy mi lehet egy projekt esetén kulcsfontosságú? Szinte minden, de érdemes kiindulni a Microsoft által ajánlott konvenciókból (https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions). A könyv eddigi részeiben bemutatott kódrészletek ezeket többségében követik.

Ha a kódolási konvenciók kialakításra kerültek, akkor a nehezebb feladat ezek betartatása. Ennek egy módszere a kód keview. A kód review lényegében az elkészült kód beolvasztás előtti áttekintése egy vagy több ember által. Ez egyrészt a konvenciók követését ellenőrzi, másrészről pedig a minőségbiztosítás egy eszköze, mivel ilyenkor a megírt kód minősége és logikája is átnézésre kerül.

Ez az átnézendő sorok számától függően akár több órás folyamat is lehet, ami egyrészt fárasztó, mársrészt pedig senki sem tévedhetetlen. Ezért nagy segítség lenne, ha ezeket a konvenciókat már kódolás közben rá tudnánk "kényszeríteni" a fejlesztőkre.

Lényegében erre való az EditorConfig projekt. Ez a leírása alapján:

"Az EditorConfig segít konzisztens kódolási stílusok fenntartásában több fejlesztő számára, akik ugyanazon a projekten dolgoznak különböző szerkesztőkben és IDE-kben. Az EditorConfig projekt egy fájlformátumból valamint olyan szövegszerkesztő beépülő modulok gyűjteményéből áll, amelyek lehetővé teszik a szerkesztők számára a fájlformátum olvasását és a meghatározott stílusok betartását.

A fájlformátum a kódolási stílusok meghatározására szolgál, könnyen olvashatók, és szépen együttműködnek a verziókezelő rendszerekkel. "

Az EditorConfig fájlokat a Visual Studio a 2019-es változat óta támogatja és a 2022-es verziótól kezdve egy grafikus szerkesztővel is rendelkezik.

Az EditorConfig fájl onnan ismerhetÅ‘ fel, hogy a neve .editorconfig. Visual Studio-ban egy projekten belül az "Add new item" dialógusban hozható létre.

Parancssorból pedig a következőképpen tudunk létrehozni egy alapértelmezettet:

dotnet new editorconfig

A fájlt egyébként a projekt veziókezelt főmappájába érdemes elhelyezni, így a főmappában lévő projektfájlra alkalmazhatjuk ugyanazt a szabályrendszert.

A szabályok szerkesztésénél beállítható, hogy milyen szinten legyenek ezek kezelve. Ezek a következőek a legmegengedőbbtől a legszigorúbb felé:

• Refactoring only

  Ebben az esetben csak a CTRL+. hatására megjelenő menüben kapunk ajánlást a javításról.

• Suggestion

  A konvenciónak nem megfelelő részek zöld aláhúzást kapnak és a CTRL+. menü javítási ajánlatokkal szolgál.

• Warning

  Mint a suggestion szint, csak kiegészítve azzal, hogy a nem megfelelő részek fordítás közben figyelmeztetéseket generálnak.

• Error

  Mint a suggestion szint, csak kiegészítve azzal, hogy a nem megfelelő részek fordítási hibát generálnak.

A fájl létrehozása önmagában a beállításoktól függetlenül még nem fogja azt magával hozni, hogy az Error vagy Warning típusúra állított szabályok ténylegesen fordítási hibát vagy figyelmeztetést okozzanak. Ehhez módosítani kell a projektfájlt is.

A projektfájlban egy szimpatikus PropertyGroup-ba fel kell vennünk az alábbi sort:

<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>

Ez a grafikus felületen is beállítható a projekt beállításainál, a Code Analysis kategóriában:

A könyv ezen részének írásának pillanatában ez még egy kísérleti funkcióként érhető el, ami azt jelenti, hogy lehetnek hibái.