Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
The best kind of documentation let's you try your own code, right there
#1
Programming Reference: feature to try your own code next to code snippets
Reply
#2
(02-11-2023, 06:58 PM)CharlieJV Wrote: Programming Reference: feature to try your own code next to code snippets

In case it is of any interest.

I'm in the process of rejigging the navigation for my programming reference.

Here's a rough first draft of notes describing this feature (i.e. running sample code and trying your own code while reading about some concept/feature/whatever):

Demonstration Programs and Runs
Reply
#3
Documentation that not only shows sample code, right there, that you can run and a place for you to try your own code ...

Documentation that dynamically generates keyword lookup links from the sample code.

So you are reading a topic, see sample code, and lookup the keywords in that sample code.

That's the beauty of having the documentation not as static content, but as a single-page web application that generates documentation on-the-fly when/where needed.

Prototype setup for the Demonstration Programs and Runs documentation page.  (The "KWL" button opens the Keywords and Symbols Lookup window)

   

   
Reply


Possibly Related Threads…
Thread Author Replies Views Last Post
  BAM: Sample "meta-programming" documentation: the "now" macro CharlieJV 0 449 07-27-2023, 03:45 AM
Last Post: CharlieJV
  BAM documentation enhancement in the works: syntax diagrams CharlieJV 2 824 06-23-2023, 09:43 PM
Last Post: CharlieJV
  Just a tiny and fun bit of code CharlieJV 6 1,605 06-15-2023, 02:54 PM
Last Post: CharlieJV
Lightbulb Allow source code to run, but not show it mnrvovrfc 6 1,371 02-12-2023, 04:54 PM
Last Post: CharlieJV

Forum Jump:


Users browsing this thread: