Re:Architect – A Serverless Framework
by Xeoncross on Monday June 11, 2018 @02:34PM
(#17287033)
Rather than inline-comments I've always had separate documentation. This helps prevent trying to cram all the edge case caveats and everything into the configuration file.
[ Parent
| on HN ]
inline comments are handy for pointing out "non standard" configuration settings for your enviroment. especially on production systems.
It aids in troubleshooting greatly to have inline comments point out "odd" settings in configuration without having to look at seperate (usually old) documentation.