[swift-evolution] [Proposal] Replace all Swift comments by end notes.

Alex Blewitt alblue at apple.com
Tue Jan 17 05:30:18 CST 2017

On 16 Jan 2017, at 15:28, Amir Michail via swift-evolution <swift-evolution at swift.org> wrote:
> Why not replace all Swift comments by end notes at the end of each source file so as to minimize the impact of misleading/outdated comments on code comprehension?

A strong -1 from me. Moving comments aside from the place where the code is defined is going to maximise outdated comments, not minimise it.

> You don’t necessarily need to scroll to the end of the source file to read a referenced end note in the code since the IDE could show a popup whenever the mouse pointer lingers over an end note reference (e.g., a number/label).
> Maybe this would encourage programmers to write more self-explanatory code while keeping (end note) comments to a minimum?

This proposal would certainly discourage having accurate comments.


More information about the swift-evolution mailing list