This is a proposal to adopt the use of // ENTRYPOINT
comments next to a program's top-level entrypoints, such as the main
function, event handlers, and network listeners.
The idea is to allow new contributors and curious readers to quickly gain an overview of the project's main functions in a way that's easy to understand, and for the entrypoints to act as sensible starting points (and helpful mental anchor points) for further exploration.
The presence of ENTRYPOINT comments should allow the reader to quickly begin to answer questions like what does this program do? (provided the main
function is sufficiently readable); what happens when I press a key?; and how does this program respond to network requests?.
Tooling