Tipps bei gleichen Typen- und Variablennamen

  • Allgemein

Es gibt 5 Antworten in diesem Thema. Der letzte Beitrag () ist von Niko Ortner.

    Tipps bei gleichen Typen- und Variablennamen

    Hallo

    Bei mir passiert es recht oft, dass ich einerseits einen guten Namen für eine Property habe, andererseits der Name für den Typ der Property aber auch genau passen würde.

    Z.B.

    VB.NET-Quellcode

    1. Enum ToStringMode As Integer
    2. Value = 0
    3. Name = 1
    4. End Enum
    5. Public Class Foo
    6. Public Property ToStringMode As ToStringMode
    7. Public Overrides Function ToString() As String
    8. Select Case ToStringMode
    9. Case ToStringMode.Value
    10. '...
    11. End Select
    12. End Function
    13. End Class


    Das sieht erstens sehr komisch aus, zweitens soll man Variablen nicht Typennamen geben.

    In diesem konkreten Beispiel habe ich an das Enum "FooToStringMode" getauft, da es übersichtlich genug ist.
    Aber da könnten auch schwierigere Situationen auftreten.

    Habt ihr da Tipps, wie man sowas lösen oder umgehen kann?
    "Luckily luh... luckily it wasn't poi-"
    -- Brady in Wonderland, 23. Februar 2015, 1:56
    Desktop Pinner | ApplicationSettings | OnUtils
    Wirklich problematisch ist das eiglich nur bei Enums, oder?

    Weil ein Enum ist einerseits ein Typ, hat annererseits nur einen einzigen Concern, und wenn man sprechend benamen will, böte sich logisch derselbe Name sowohl für den Typ an als auch für eine Variable dieses Typs.

    Bei Non-Public Vars mache ich ja immer _ vor den Variablen-Namen, also das geht. Aber wenn Public sein muß, dann modifizier ich eben den Enum-Namen, aber ich hänge "Enm" hinten an, damit Intellisense ebenso intuitiv bleibt wie zuvor.
    Wirklich schön finde ich das auch nicht, aber was besseres weiß ich auch nicht.

    Man kann auch "Style", "State" oder "Mode" anhängen, wie mans zB bei der Control.Dock - Property sieht, vom Typ DockStyle.
    Das passt häufig zum Concern eines Enums, aber nicht immer.
    @picoflop:Das passt sogar sehr schön. Fügt sich ideal ein und ist auch noch kurz. Danke für den Tipp.

    @ErfinderDesRades: Du hast recht. Das passiert hauptsächlich bei Enums.
    Die _-Schreibweise ergibt sich bei mir zur Zeit, da ich viele ReadOnly Properties habe. Aber ich versuche auch so den Namen der Variable vom Namen des Types unterscheidbar zu halten.
    "Style", "State" und "Mode" sind gute Ideen. "Type" bietet sich auch manchmal an, oder wie von Picoflop erwähnt "Option(s)"

    @xtts02: Danke für den Link. Ich werde mir das mal ansehen.


    Edit:
    Bei der von xtts02 verlinkten Seite habe ich jetzt das gefunden:

    Möglicherweise empfiehlt es sich, für eine Eigenschaft den gleichen Namen wie für ihren Typ festzulegen.

    Wenn eine Eigenschaft eine starke Typisierung als Enumeration aufweist, kann der Name der Eigenschaft mit dem Namen der Enumeration übereinstimmen. Wenn beispielsweise der Name einer Enumeration CacheLevel lautet, kann eine Eigenschaft, die einen der Enumerationswerte zurückgibt, ebenfalls CacheLevel lauten.


    Steht also leider im Konflikt mit unserer Herangehensweise.
    "Luckily luh... luckily it wasn't poi-"
    -- Brady in Wonderland, 23. Februar 2015, 1:56
    Desktop Pinner | ApplicationSettings | OnUtils

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Niko Ortner“ ()