I did a little nosing around to see how some other languages that I know allow optional arguments and have [] in the syntax handle this in their docs (php and javascript). php uses the MFC syntax conventions (ex here: http://www.php.net/manual/en/function.opendir.php), while javascript does not mark arguments as optional, but uses a javadoc style of where each of the arguments is in a list and the description indicates whether the argument is optional or required (http://www.w3schools.com/jsref/jsref_substr.asp). I think I'm sort of in favor of having the description and characteristic of each argument be documented in the javadoc-style rather than buried in the test the way it's traditionally been done with Rexx. That's a much bigger effort to rework, and will probably get done incrementally unless we can find someone with enough ambition to start tackling that task.
Rick On Sun, Aug 24, 2008 at 12:18 PM, Mark Miesfeld <[EMAIL PROTECTED]> wrote: > On Sun, Aug 24, 2008 at 9:03 AM, David Ashley <[EMAIL PROTECTED]> wrote: > >> The problem with the MFC syntax is that he used a character for options (the >> square brackets) that were not a part of classic Rexx. With ooRexx I think >> it would be confusing since square brackets are a part of the character set. >> >> But I am open to other ideas and alternatives. I am not much of a fan of the >> railroad diagrams either. > > One option, that I'm just throwing out, might be to use a different > font and / or bolding for the optional and the required args. > > I'm not sure myself about that. I'd have to see what it actually > looked like. If it came out that the difference between the optional > and required args was visually distinctive, then it might be a viable > option. > > -- > Mark Miesfeld > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > Oorexx-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/oorexx-devel > ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Oorexx-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/oorexx-devel
