Home | Reviews | GUIpedia | Forum | Fun500
| ksr | Scripting language documentationI've just started work on a scripting language idea of mine, but what do you think is the best way of documenting all of the commands etc? Text file? Word document? Wiki? Something else? | 2008-07-22 | 9:50 AM |
| Todd | Re:Scripting language documentationI prefer something along the lines of documentation similar to the PHP documentation. You just type in the function and it takes you either straight to the page or gives you multiple results. Plus it provides you with examples for each function. | 2008-07-22 | 10:19 AM |
| ksr | Re:Scripting language documentation[b]tlsuess wrote:[/b]
[quote]I prefer something along the lines of documentation similar to the PHP documentation. You just type in the function and it takes you either straight to the page or gives you multiple results. Plus it provides you with examples for each function.[/quote]
I suppose a wiki (or a custom site with a search feature) would be best then. | 2008-07-22 | 10:27 AM |
| Todd | Re:Scripting language documentationPreferably. But personally the one downside (and major one at that) is that ANYONE can edit it. I'd just say make something along the lines of that and allow people to post comments. PHP's documentation online allows for people to post comments regarding the code or function that is documented. | 2008-07-22 | 10:30 AM |
| Brandon | Re:Scripting language documentationno. you can lock a wiki so only registered users can edit and then filter who can register. I think with a Wiki it should be download-able as usually I develop in Win98 and putting it on-line is a bad idea. | 2008-07-22 | 10:41 AM |
| Todd | Re:Scripting language documentationBut even certain registered users can go evil and ruin it. If we have a place for people to comment on the function with possible help or example code, that might make it more attractive and user friendly.
Yeah none of my Windows 98 machines have ever been online. You could try downloading the wiki then making a CHM or HTML-help file. | 2008-07-22 | 10:46 AM |
GUIs
2021 Brandon Cornell
