New function intro comment format for Rebol C source #27
Description
A new commenting format is proposed for the Rebol C sources for which your acceptance is sought.
Example:
//
// quit: native [
//
// {Stop evaluating and return control to command shell or calling script.}
//
// /with {Yield a result (mapped to an integer if given to shell)}
// value [any-type!] "See: http://en.wikipedia.org/wiki/Exit_status"
// /return "(deprecated synonym for /WITH)"
// return-value
// ]
//
// While QUIT is implemented via a THROWN() value that bubbles up
// through the stack, it may not ultimately use the WORD! of QUIT
// as its /NAME when more specific values are allowed as names.
//
REBNATIVE(quit)
{
To see the effect of this in context with other functions see the draft conversions at: https://github.com/codebybrett/temporary.201508-source-format-change/tree/master/src
An introductory comment to a function declaration will contain rebol function metadata indented from slash by two spaces, a blank line, then any ordinary comments set off from double slash by a single space. Extra blank lines around the function description make easier reading.
Your opinions would be welcome in the chat room.