Firmeninterne Kodierungsrichtlinien

  • Allgemein

Es gibt 19 Antworten in diesem Thema. Der letzte Beitrag () ist von RodFromGermany.

    Firmeninterne Kodierungsrichtlinien

    Moin Fans,
    vor mir liegt folgende Aufgabe:
    Ich soll für meine Firma verbindliche Kodierungsrichtlinien aufstellen. Herr Google hat mit da einige Anhaltspunkte, aber keine (firmenintern juristisch) anwendbaren Regeln gegeben.
    Anhaltspunkte sind:
    • Projekteinstellungen
    • Gestaltung von Quelltext
    • Wartbarkeit
    • Länge einzelner Prozeduren
    • Anzahl der Parameter
    • Dokumentation von Quellcode
    • Testfeatures (Tools, automatische Tests)
    • ...
    Hat jemand von Euch / Gibt es bei Euch derartige Dokumente, die sich nachnutzen lassen?
    Kennt Ihr Literatur zu diesem Thema?

    Danke im voraus.
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    @picoflop:
    Danke, sehr informativ und nützlich.
    Leider sind wir hier auf VB festgelegt, auch wenn ich selbst C# bevorzuge.
    @GambaJo:
    Dank auch Dir,
    alle diese Stichworte (und noch viele mehr) sind in meiner Liste bereits vorhanden.
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    hmm, das Netz ist voll davon, wenn Du nach Coding standards suchst. Versuche Dich eher an Best Practices auszurichten, statt dem deutschen Normalisierungswahn zu verfallen.

    Ein paar Links
    - Microsoft Design Guidelines for Developing Class Libraries
    - C# Coding Standards document ( Lance's whiteboard)
    - C# Code Guidelines & Best Programming Practices
    - Exception Handling Best Practices in .NET auf Codeproject

    Ausserdem könnte Dich das MS Tool FXCop interessieren

    Dank Dir, Kangaroo.
    Achtung Nachnutzer:
    Die Beschreibung im 4. Link von Kangaroo ist nicht ganz korrekt.

    VB.NET-Quellcode

    1. try { ... }
    2. catch (Exception ex)
    3. {
    4. throw ex;
    5. }

    und

    VB.NET-Quellcode

    1. try { ... }
    2. catch (Exception ex)
    3. {
    4. throw;
    5. }

    liefern beide denselben StackTrace!

    VB.NET-Quellcode

    1. try { ... }
    2. catch (Exception ex)
    3. {
    4. throw new Exception("Test", ex);
    5. }

    übergibt den StackTrace an die InnerException
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    Hey,

    @RodFromGermany: Wenn du deinen 1 oder 3 code Verwendest, verwirfst du aber die "Spezifikation" der Exception. Nur bei throw; wird die Exception 1:1 neu ausgelöst.

    Wenn bei Variante 1 eine OutOfMemoryExeption ausgelöst wird, löst du eine normale Exception neu aus -> Deshalb immer nur throw;

    lg.

    LucaWelker
    lg.

    LucaWelker

    Ich kann natürlich in einem Select alle gängigen Exceptions abfangen, das ist nicht unbedingt erforderlich.
    Wichtig ist doch, dass ich genau weiß, wo welcher Fehler aufgetreten ist.
    Ich hab folgende Beispiele (ExecutionEngineException ist willkürlich, Exception sollte es nicht sein):

    VB.NET-Quellcode

    1. Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
    2. Try
    3. Test()
    4. Catch ex As Exception
    5. Stop ' hier kommt "ExecutionEngineException" der Zeile "Throw" an, falsch
    6. End Try
    7. End Sub
    8. Private Sub Test()
    9. Try
    10. Throw New ExecutionEngineException ' diese Zeile benötige ich
    11. Catch ex As Exception
    12. Throw ' diese Zeile kommt oben an, falsch
    13. End Try
    14. End Sub

    VB.NET-Quellcode

    1. Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
    2. Try
    3. Test()
    4. Catch ex As Exception
    5. Stop ' hier kommt "ExecutionEngineException" der Zeile "Throw New ExecutionEngineException" an, richtig
    6. End Try
    7. End Sub
    8. Private Sub Test()
    9. Try
    10. Throw New ExecutionEngineException ' diese Zeile kommt oben an, richtig
    11. Catch ex As Exception
    12. Throw New Exception("Test", ex)
    13. End Try
    14. End Sub
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    @LucaWelker:
    Also das ist leider nicht so.
    Obiger VB-Code in C# umgesetzt liefert selbstverständlich dieselben Resultate.
    Throw leitet zwar den Inhalt der Exception weiter, setzt aber einen neuen Stacktrace auf, und genau das soll nicht sein.
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    Also bei uns in der Firma werden alle bzw. die meisten Exceptions so weitergeleitet und verarbeitet. In c# sowie in Delphi(raise). Und bei der Weiterverarbeitung in einem anderen Teil, sind immer noch 100% die Exceoption die gleichen.

    lg.

    LucaWelker
    lg.

    LucaWelker

    Erstell Dir mit ein paar Klicks diese Anwendung und sieh nach, was rauskommt.
    Die Praxis ist das Kriterium der Wahrheit. (Lenin ;( )
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    Code meiner Klasse:

    Quellcode

    1. public FtpWebResponse loadAllFiles(string path)
    2. {
    3. request = (FtpWebRequest)FtpWebRequest.Create(new Uri(path));
    4. request.Method = WebRequestMethods.Ftp.ListDirectory;
    5. //request.Credentials = credentials;
    6. request.UsePassive = false;
    7. request.UseBinary = true;
    8. request.KeepAlive = false;
    10. FtpWebResponse response;
    11. try
    12. {
    13. response = (FtpWebResponse)request.GetResponse();
    14. status = response.StatusDescription;
    15. }
    16. catch (Exception ex)
    17. {
    18. //status = ((FtpWebResponse)ex.Response).StatusDescription;
    19. throw;
    20. }
    21. finally
    22. {
    23. request.Abort();
    24. }
    25. return response;

    Code meines Hauptprogrammes:

    Quellcode

    1. try
    2. {
    3. FtpWebResponse response = files.loadAllFiles("ftp://luca-welker.com/test/");
    4. }
    5. catch (Exception ex)
    6. {
    7. Console.WriteLine(ex.GetType());
    8. }


    Ergebniss auf der Konsole:




    Und da haben wir die WebException.. Obwohl ich niemals von hand eine WebException ausgelöst habe.

    lg.

    LucaWelker
    lg.

    LucaWelker

    Ich brauche primär die Programmzeile, in der die Exception ausgelöst wurde, denn ich muss ja ggf. den Fehler im Code reparieren. Die Art der Exception ist da zweitrangig.
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

    Es gibt bestimmt noch andere elegantere Wege (die ich leider noch nicht kenne).
    Für mich habe ich bisher etwa so gelöst:
    Spoiler anzeigen

    VB.NET-Quellcode

    1. Public Class Form1
    3. Private Sub ShowMyException(ByVal ex As MyBaseException)
    4. MessageBox.Show("Modul : " & ex.Modul & vbCrLf & _
    5. "Methode: " & ex.CallingProc & vbCrLf & _
    6. "Message: " & ex.Message, _
    7. ex.CallingProc, MessageBoxButtons.OK, MessageBoxIcon.Error)
    8. End Sub
    10. Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    11. Try
    12. 'Me.Test2()
    13. Me.Test1()
    14. Catch ex As MyBaseException
    15. Me.ShowMyException(ex)
    16. Catch ex As Exception
    17. MessageBox.Show(ex.Message)
    18. End Try
    19. End Sub
    21. Private Sub Test2()
    22. Try
    23. Throw New MyBaseException("Test vom Form1, Methode Test2 ...")
    24. Catch ex As Exception
    25. Throw
    26. End Try
    27. End Sub
    29. Private Sub Test1()
    30. Try
    31. TestClassA.TestClassB.TestProc1()
    32. Catch ex As Exception
    33. Throw
    34. End Try
    35. End Sub
    37. ' Klasse A
    38. Public Class TestClassA
    39. ' Klasse B
    40. Public Class TestClassB
    41. ' Methode 1
    42. Public Shared Sub TestProc1()
    43. Try
    44. Throw New MyBaseException("Blabla ....")
    45. Catch ex As Exception
    46. Throw
    47. End Try
    48. End Sub
    49. End Class
    50. End Class
    52. End Class
    54. ''' <summary>
    55. ''' Eigene Exceptionklasse
    56. ''' </summary>
    57. ''' <remarks></remarks>
    58. Public Class MyBaseException
    59. Inherits System.Exception
    61. Private _CallingProc As String
    62. Private _Modul As String
    64. Public Sub New(ByVal message As String)
    65. MyBase.New(message, Nothing)
    66. _CallingProc = Me.GetCallingProc ' Aufrufende Methode ermitteln
    67. _Modul = Me.GetModul
    68. End Sub
    70. Public Sub New(ByVal message As String, ByVal innerException As Exception)
    71. MyBase.New(message, innerException)
    72. _CallingProc = Me.GetCallingProc ' Aufrufende Methode ermitteln
    73. _Modul = Me.GetModul
    74. End Sub
    76. Public ReadOnly Property CallingProc() As String
    77. Get
    78. Return _CallingProc
    79. End Get
    80. End Property
    82. Public ReadOnly Property Modul() As String
    83. Get
    84. Return _Modul
    85. End Get
    86. End Property
    88. Private Function GetCallingProc() As String
    89. Try
    90. Return (New StackTrace).GetFrame(2).GetMethod().Name
    91. Catch ex As Exception
    92. Return String.Empty
    93. End Try
    94. End Function
    96. Private Function GetModul() As String
    97. Try
    98. Return (New StackTrace).GetFrame(2).GetMethod.ReflectedType.ToString
    99. Catch ex As Exception
    100. Return String.Empty
    101. End Try
    102. End Function
    104. End Class

    Zur Erläuterung noch mal alles zusammengefasst:
    Quelltext:
    Spoiler anzeigen

    VB.NET-Quellcode

    1. Public Class Form1
    2. Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
    3. Try
    4. Test1()
    5. Catch ex As Exception
    6. ' hier kommt "ExecutionEngineException" der Zeile "Throw" an, falsch
    7. rtb.Text = ex.ToString
    8. End Try
    9. End Sub
    11. Private Sub Test1()
    12. Try
    13. Throw New ExecutionEngineException ' die Nummer dieser Zeile benötige ich
    14. Catch ex As Exception
    15. Throw ' die Nummer dieser Zeile kommt oben an, falsch
    16. End Try
    17. End Sub
    19. Private Sub Button2_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button2.Click
    20. Try
    21. Test2()
    22. Catch ex As Exception
    23. ' hier kommt "ExecutionEngineException" der Zeile "Throw New ExecutionEngineException" an, richtig
    24. rtb.Text = ex.ToString
    25. End Try
    26. End Sub
    28. Private Sub Test2()
    29. Try
    30. Throw New ExecutionEngineException ' die Nummer dieser Zeile kommt oben an, richtig
    31. Catch ex As Exception
    32. Throw New Exception("Test", ex)
    33. End Try
    34. End Sub
    35. End Class

    Button1 --> rtb.Text:
    Spoiler anzeigen
    "System.ExecutionEngineException: Interner Laufzeitfehler.
    bei Test1.Form1.Test1() in C:\Projects\Test1\Form1.vb:Zeile 15. :(
    bei Test1.Form1.Button1_Click(Object sender, EventArgs e) in C:\Projects\Test1\Form1.vb:Zeile 4."

    Button2 --> rtb.Text:
    Spoiler anzeigen
    "System.Exception: Test ---> System.ExecutionEngineException: Interner Laufzeitfehler.
    bei Test1.Form1.Test2() in C:\Projects\Test1\Form1.vb:Zeile 30. :)
    --- Ende der internen Ausnahmestapelüberwachung ---
    bei Test1.Form1.Test2() in C:\Projects\Test1\Form1.vb:Zeile 32.
    bei Test1.Form1.Button2_Click(Object sender, EventArgs e) in C:\Projects\Test1\Form1.vb:Zeile 21."
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!

Facebook
Telefonspende