I've been wondering about how to deal with markup in fandoc comments. For an IDE, it'd be nice if the fandocs could be presented better than just raw text: active URI links, for example; maybe some simple markup (bold, italic, list items, I don't know; author and mod date, maybe).
I hesitate because it's easy to turn it into something nasty, where the textual form of the comment is unreadable and unmaintainable, and you're locked in to whatever your IDE wants to make you do.
The Fandoc tool seems to be using an annotation style (@def=true) for default params, is there some documentation or thought on where this is going?
Mostly I'm wondering what others think; do we want to stay minimal and textually clean, should we work toward some form of html-style markup and auto-generated annotations, does it not really matter until down the road a ways?
tcolarSun 12 Jul 2009
Can't you just have for example a bold tag around the link ? That should work. http://www.google.com
tcolarSun 12 Jul 2009
That was **`http://www.google.com`**
tcolarSun 12 Jul 2009
... Since fandoc supports the same wiki syntax as sidewalk (wiki)
KevinKelleySun 12 Jul 2009
I guess it's been a while since I looked, or something. Now I see there's a Fandoc page that covers it.
Since fandoc supports the same wiki syntax as sidewalk (wiki)
I was only vaguely aware of that, looks like I've already been answered.
KevinKelley Sun 12 Jul 2009
I've been wondering about how to deal with markup in fandoc comments. For an IDE, it'd be nice if the fandocs could be presented better than just raw text: active URI links, for example; maybe some simple markup (bold, italic, list items, I don't know; author and mod date, maybe).
I hesitate because it's easy to turn it into something nasty, where the textual form of the comment is unreadable and unmaintainable, and you're locked in to whatever your IDE wants to make you do.
The Fandoc tool seems to be using an annotation style (
@def=true
) for default params, is there some documentation or thought on where this is going?Mostly I'm wondering what others think; do we want to stay minimal and textually clean, should we work toward some form of html-style markup and auto-generated annotations, does it not really matter until down the road a ways?
tcolar Sun 12 Jul 2009
Can't you just have for example a bold tag around the link ? That should work. http://www.google.com
tcolar Sun 12 Jul 2009
That was **`http://www.google.com`**
tcolar Sun 12 Jul 2009
... Since fandoc supports the same wiki syntax as sidewalk (wiki)
KevinKelley Sun 12 Jul 2009
I guess it's been a while since I looked, or something. Now I see there's a Fandoc page that covers it.
I was only vaguely aware of that, looks like I've already been answered.