*-- Some text here ------------------------------------------------------
Adding all the dashes doesn't make it more or less of a comment. It just adds addtional characters that distract and add to the comment problem.*-- Create some object ------------------------------------------------- IF SomeCondition this.GetSomething(someParameter) ENDIF *-- Create some other object ------------------------------------------------- IF SomeOtherCondition this.GetSomethingElse(someParameter) ENDIFIt would be self documenting and not need any comments if it read
SomeObject = MethodCreateSomeObject(someParameter) SomeOtherObject = MethodCreateSomeOtherObject(someParameter)See the book Clean Code by Robert Martin