Monday, May 14, 2012

Meta syntax, or syntax for documenting syntax

While going through and properly documenting old code, I was wondering, what standards are there for documenting syntax?




  • regular expressions: there's no single standard, and it's a little confusing to read.

  • the one used in python documentation (here's an example): it looks nice, but I haven't been able to find the specification anywhere.



Are there any others, and which one is best?





No comments:

Post a Comment