Skip to content
DevMeme
1028 of 7590
Documentation Post #1156 · source on Telegram

Comments Explaining The Nose Cone

Description

A collage shows a bright green Kulula airplane covered in white arrows and explanatory labels, with the large text "flying 101" on the fuselage. Readable labels include "the big cheese (captain, my captain)," "co-captain (the other pilot on the PA system)," "front door," "galley," "nose cone (radar, antenna and a really big dish inside)," "black box (which is actually orange)," "landing gear," "seats," "kulula fans," "secret agent code," and "THIS WAY UP," while many smaller annotations are present but too tiny to fully read. With the post caption about being asked to comment code, the image jokes about overly literal comments that label obvious structures instead of documenting intent, constraints, or non-obvious behavior.

Comments

1
Anonymous ★ Top Pick A comment that says `noseCone = nose cone` is not documentation; it is a lint rule for the reader's patience.
  1. Anonymous ★ Top Pick

    A comment that says `noseCone = nose cone` is not documentation; it is a lint rule for the reader's patience.

Use J and K for navigation