documentation-generation

Are there any tools for generating documentation for TypeScript source code? Or should I use something generic like NaturalDocs? What would be the recommended style of the block comments / those intended for standalone volume of documentation. Should I use: ///<foo>bar</foo> MSVS kind of comments? or /** @javadoc style comments */ or perhaps /* Something like this? */ I'm afraid to use /// because it is used for imports, and I don't want to tread on some other future feature possibly introduced in the similar way - but you never know... Or is it possible to generate documented JavaScript from

If I have a REST based service written in the Symfony [symfony-project.org] framework (i.e. PHP), is there any decent tools/frameworks out there that will parse my code and generate API documentation? The Java based framework enunciate has documentation capabilities similar to what I need, you can view an example of this here: http://enunciate.codehaus.org/wannabecool/step1/index.html . I understand the premise of REST based services are supposed to be self evident, however I was after something that would generate this documentation for me without the need to manually write up all my

Is there an easy way to generate docs for REST api direct from a Symfony project? Sorry for the post digging, but there is a Symfony bundle to help API doc generation, you can check out NelmioApiDocBundle which interconnects well with FOSRestBundle . The FOSRestBundle documentation provides sample bundles using both bundles to generate REST-ful web services and their documentation. 来源： https://stackoverflow.com/questions/8872276/auto-generate-rest-api-docs-from-symfony

Using roxygen2 documentation with devtools document function automatically generates a Collate: field in the package DESCRIPTION, regardless of whether or not it is necessary to load the package library files in a particular order. I'm working on a package with a bunch of S4 methods and want to be sure the class definitions are loaded before any methods or other classes using them, which I understand I can do with the Collate list, but I'm not sure how to indicate this in the roxygen2 documentation format. The roxygen2 manual makes some reference to an @include tag but that looks like it might

We have a large framework created using VB Script, which has been created and then maintained for the past few years. This code was initially well documented and all the initial functions and variables and files had good headers in them. Later in maintainence, the code got obfuscated by the coders not keeping track of new and changed functionality and the final result now in my hands is a code which has around ~600 files and none of them have the proper description of the functions and variables in them :-( Could someone inform if they have created documents (on the fly types - dOxygen, etc.)