Mario,

The idea of literate Programming, or self documentation is supportive of 
community development and reuse. Sometimes the main thing is to lead by 
example, other developers can jump on the bandwagon. The Truth is self 
documentation needs to be inline with the code. I have not seen any inline 
commenting features, do you know any?

I took your hint and created a tiddler ShowCode and Tagged it 
$:/tags/ViewTemplate

<$list filter=[is[current]tag[ShowCode]]>
<pre><$view field="text"/></pre>
</$list>

If we had a comprehensive "Language Guide" reference for tiddlywiki we 
could allow self documentation to reference entries in the reference. For 
example 

<- If the Current tiddler is tagged ShowCode display the text field without 
wiki formatting - See Docs Display in view template ->
<$list filter=[is[current]tag[ShowCode]]>
<pre><$view field="text"/></pre>
</$list> 

It would be nice to have a toggle in the More toolbar to do this, actually 
a generic way to add tag toggles to the toolbar would be nice.

The Truth is in some cases exhaustive self documentation can give rise to 
bloat, so an ability to save a tiddlywiki or a tiddler with the self 
documentation automatically removed should be available. This should be 
trivial if we have a standard way to comment code, A standard "code notes 
field" or "code reference" link may also help

The capture of self documented code patterns in a repository would also be 
helpful, a kind of Git for code snippets, code tiddlers "code reference 
link " could then point to an entry in the repository that documents the 
code (in Reuse cases).

Regards
Tony


-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/tiddlywikidev.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywikidev/534682ed-bc37-456e-b76e-c7ca3e67f5aa%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to