Use comments with care. The 5-line Boolean function below is my revision of 13 lines of code with nine more comment lines. The longer version was an Internet instructor’s example, with the direction to comment nearly every line of code (terrible idea, even for beginners). Self-documentation is better.
def isAllVowels(stng):
for ch in stng.lower():
if ch not in ['a', 'e', 'i', 'o', 'u']:
return False
return True
Self-documenting code
eliminates the need for many comments. But we still need comments for the following reasons:
- a.
to show organization (break ...
