Kommentek szépen és egyszerűen - Avagy hogyan gyártsunk olvasható kódot

Egy kód ugye akkor szép, ha frankón kommentezve vagyon, és ki lehet rajta igazodni.

Namármost elég sok cuccot kipróbáltam, de kevés olyan tool/plugin van, ami a programozók életét segíti, bugmentes, nem lassítja a visual studio működését, és öröm használni. GhostDoc nem rossz, de tudomásom szerint nem lehet vele a cs fileokhoz szép és értelmes header-t generálni (mint pl lsd lejjebb).

Én találtam valamit. Még nem használtam ki minden feature-t, egyelőre örülök magamnak. DevExpress-es cucc (nem kell megijedni, lehet hogy nem minden DevExpress-es cucc bugos :) ), amit fel kell tenni, ez egy Visual Studio Plugin. Neve CodeRush Xpress (ez van ingyér). Ehhez a Plugin-hez lehet írni saját egyéb plugineket, ragyogó. De nekünk nem kell írni sajátot, szerencsére volt aki megcsinálta, codeproject-en találtam egyet, az való a kommentezésre, és ami miatt kerestem, nagyon szuper HEADER-t lehet generálni a cs fileokhoz vele. Pl most így néznek ki a cs fileokban a header-jeim:

#region Copyright(C) 2010 Crystal Clear
/////////////////////////////////////////////
// Project: CC.ECM.SPS.Components.Extender
// Namespace: CC.ECM.SPS.Components.Extender.Handlers
// Class: RichTextEditorExtender
// User: WIN-HYW10O1DBJQ\Rendszergazda
// Created: 2010.01.20. 10:40
// Modified: 2010.01.27. 23:09
/////////////////////////////////////////////
#endregion

Valamint azt is tudja (ennek Lelez örülni fog, meg én), hogy ha egy kapcsos zárójelet bezárunk, akkor kommenteli a záró tagot, hogy mely részt zárja le.
pl ami pirossal van:

protected override void OnPreRender(EventArgs e)
{
base.OnPreRender(e);

if (EditorControl.Handler != null)
{
EditorControl.Handler.ForceLoad();
_editor.Content = EditorControl.Handler.HtmlData;
}
}// OnPreRender()

Soksok szép és jó dologra való még a devexpress-es cucc is, csak lestem, pár videót megnéztem.

Itt nézelődjetek, ha valakinek van rá ideje, és érdekli, szerintem érdemes:
http://www.devexpress.com/Products/Visual_Studio_Add-in/Coding_Assistance/

Jó kis video ízelítőnek (számtalan egyéb jó video is van):
http://tv.devexpress.com/CRX91FeaturesCS.movie

Ami a jó kommentezéshez kell, jól ismert codeproject oldalon:
http://www.codeproject.com/KB/macros/commenter.aspx

Ha valaki ki akarja próbálni, 2 trükk kell commenter plugin telepítésekor, kérdezzen, segítek!

Telepítésről röviden:
Először a CodeRush Xpress-t kell feltenni, ez tök jól felmegy.
A CodeProject oldalon van 2 letölthető csomag, nem az installert kell letölteni, hanem a forrást. Azért, mert az installer egy régebbi coderush-hoz van, és nem megy fel, nem találja a megadott helyen a szükséges coderush-os dll-eket.
Leszedjük a forrást, fordításkor elszáll, no para, csak a referenciák nem stimmelnek. Egyenként kitöröljük őket, és hozzáadjuk újra (a felment a coderush, akkor megtaláljuk könnyen).
Ha ez megvan, akkor lefordítjuk, és a friss dll-t meg bemásoljuk a CodeRush mappájába, nekem ide kellett:
c:\Program Files\DevExpress 2009.3\IDETools\System\DXCore\BIN\PLUGINS\
de lehet hogy ide is kell:
c:\Program Files\DevExpress 2009.3\IDETools\System\CodeRushXpress\BIN\PLUGINS\
Ezek után, hogy a hotkey-ek működjenek, és egyáltalán a coderush options menüjét el tudjuk érni (CTRL+SHIFT+ALT+O), nem elég a Visual Studio-t elindítani, a gépet is újra kell (sajna).
Ennyi. Ezek után használható, a fent említett linkeken van szó arról, hogyan kell használni és konfigolni.

Update 1.: Találtam egy olyan feature-t, hogy ha valahol a kódban egy úgymond beégetett stringet hozol létre, felajánlja, hogy kiteszi constans-ba, választható hogy hova (pl kód elejére, private constansnak, vagy local constans, resource-ba is kirakja ha kell, ami szerintem frankón megkönnyíti a resource-ban tárolt szövegek kezelését....