The Weird and The Wonderful

Public Class MainForm
  Inherits Form
  Public Sub MainForm_Load(sender As System.Object, e As System.EventArgs) Handles MyBase.Load
    ' ... 21,657 lines of whitespace...
  End Sub
End Class

Public Class MyClass


   Sub DoSomething

      ' This code is to... (obvious comments)

      Dim i as Integer ' (actual code here)

      ' Assign a value to the integer (more obvious comments)

      i = 10


   End Sub



   Sub NextMethod

      ' etc.


   End Sub





End Class

public class Naerling : Lazy<Person>{}

''' <summary>
''' Information about an animal.
''' </summary>
Public Class Animal

#Region "Constants"
   Private Const HIGHLANDER As Integer = 1
  Private Const BUNCH_MIN As Integer = 10
  Private Const COUPLE_NAME As String = "couple"
  Private Const BUNCH_NAME As String = "bunch"
  Private Const TEMPLATE_DESCRIPTION_SINGLE As String = "There is one baby {1}."
  Private Const TEMPLATE_DESCRIPTION_MANY As String = "There are a {0} of baby {1}s."

#End Region


#Region "Properties"
   ''' <summary>
  ''' The name of this type of animal (duck, hamster, ...).
  ''' </summary>
  Public Property AnimalName As String

#End Region


#Region "Methods"
   ''' <summary>
  ''' Gets a description of the number of children this animal has.
  ''' </summary>
  ''' <param name="count">The number of children.</param>
  ''' <returns>The description ("There are a couple of baby ducks.").</returns>
  Public Function GetChildrenDescription(ByVal count As Integer) As String

    ' Variables.
    Dim description As String
    Dim countWord As String


    ' Choose description based on number of children.
    If count = HIGHLANDER Then
      description = String.Format(TEMPLATE_DESCRIPTION_SINGLE, Me.AnimalName)
    Else
      If count >= BUNCH_MIN Then
        countWord = BUNCH_NAME
      Else
        countWord = COUPLE_NAME
      End If
      description = String.Format(TEMPLATE_DESCRIPTION_MANY, countWord, Me.AnimalName)
    End If


    ' Return description of children.
    Return description

  End Function

#End Region

End Class

const WOTSITS_PER_THING = 13;
...
function Things(){
 var wotsits = getWotsitNumberFromSomewhere();
 return {things: wotsits / WOTSITS_PER_THING; leftover: wotsits % WOTSITS_PER_THING };
}

function Things(){
 var wotsits = getWotsitNumberFromSomewhere();
 return {things: wotsits / 13; leftover: wotsits % 13}; // 13 wotsits per thing
}

BobJanova wrote:

Personally, I like no comments

' Assign a value to an integer.
Dim i As Integer = 10

public class Naerling : Lazy<Person>{}

Naerling wrote:

Btw, what's the story with CONST_HAVING_UNDERSCORES_AND_CAPITOLS?

Public Const OH_OK As Boolean = True

public class Naerling : Lazy<Person>{}

Naerling wrote:

Btw, what's the story with CONST_HAVING_UNDERSCORES_AND_CAPITOLS?

I am sure it had a good reason way back when, but I fail to see it now

witm55 wrote:

I use to write that the same way I write read/write-Properties.

public class Naerling : Lazy<Person>{}

Julien Villers wrote:

Or maybe a tips/tricks entry?