Chapter 11 - Documenting your DSL

I am going to start writing this soon. Any suggestions?

As a bait, I am going to apply the techniques that I intend to describe to Binsor, which should give you incentive to say what you really want from a DSL documentation... :-)

Comments

09/03/2008 03:13 PM by

josh

Perhaps you could mention a couple choices.. I'm only familiar with two approaches: by hand, or with a tool such as sandcastle that uses xml generated by the compiler. I favor the sandcastle approach of course, but my experience is limited in this area.

09/03/2008 03:22 PM by

Ayende Rahien

I am talking about how you are going to document the DSL itself.

Implementation, syntax and the actual DSL output.

Comments have been closed on this topic.

Recent Comments

I don't think long running Stopwatch are a good practice. You might get into issues related to processors clock speeds. Read all.

By cao on Trivial Lru Cache impl

`_nodes.AddOrUpdate(key, node, (_, __) => node);` What's wrong with `_nodes[key] = node` ? `.Take(_nodes.Count / 10)` I th... Read all.

By Patrick Huizinga on Trivial Lru Cache impl

Cyrille, Doesn't work if we need to wait until the resources are disposed, then use them again. For example, we may want to... Read all.

By Ayende Rahien on TPL and the case of the !@#(*@! hung process

Let me rephrase my proposal then: Move any cleanup code at the end of Background() (out of the while loop) and remove the... Read all.

By Cyrille Dupuydauby on TPL and the case of the !@#(*@! hung process

Jeremy, Because that code is there merely to demonstrate the problem. Read all.

By Ayende Rahien on TPL and the case of the !@#(*@! hung process

Ayende @ Rahien

Refunds available at head office

Chapter 11 - Documenting your DSL

Comments

Main feed
Comments feed