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

[Robert Widmann]

~Robert Widmann

2017/01/16 10:28、Amir Michail via swift-evolution <swift-evolution at swift.org> のメッセージ:

> 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?

The location of code comments was never the issue.

> 
> 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).

As others have noted, it is really not a good idea to introduce features predicated on the existence of Xcode.

> 
> Maybe this would encourage programmers to write more self-explanatory code while keeping (end note) comments to a minimum?

This seems like it is just going to encourage a huge unmaintainable book being written at the end of every file.  The ratio of documentation to code in some libraries is 10-or-20-to-1 in some cases.

It seems like this proposal has a scaling problem.

> _______________________________________________
> swift-evolution mailing list
> swift-evolution at swift.org
> https://lists.swift.org/mailman/listinfo/swift-evolution
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.swift.org/pipermail/swift-evolution/attachments/20170116/ec6c5e52/attachment.html>