Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I've got an NSIS script that is a couple thousand lines and not properly indented making the script difficult to read. Is there a way to format NSIS script or at the minimum be able to indent the Ifs and Endifs sections? There's plenty of online script formatters for HTML, Javascript, XML, etc.
Notepad++ does an excellent job of supporting the NSI code conventions straight out of the box.
I've used EclipseNSIS for working with NSIS before; it at least uses syntax highlighting, which is nice.
Atom Editor is also really nice for NSIS, and it has some packages you can add on to make it easier to work on NSIS scripts.
I don't think I ever found anything to prettify or format the script, unfortunately, but that may now be a part of either Atom or EclipseNSIS, I'm not sure.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I'm currently using a software with its own command-line interface, accepting its own commands with parameters, but these commands are documented in several places and files, so I can't simply run doxygen on it, and its not possible to add documentation to these files now.
Dumping everything in one text document seems a bit annoying to use, so my first idea is to generate a table, SQL for example, and add the documentation there, with several columns, such as command and its description, arguments and description of them, example command, execution time, etc., and add some kind of GUI to easily display the commands.
Are there already solutions for this, especially easy to maintenance ones?
Or is it better to have a different approach for this, such as html based Helpfiles?
you could build one yourself or use some third party tools like REDGATE SQLdoc..
below is one example of how documentation is generated for one sample table as HTML,PDF as well
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I like good documentations for source code, but I hate the documentation comments in the code. I found solutions to separate the code from the documentation for other languages, but not for Rust. So, is any solution to separate the source code from the documentation in Rust out there?
Edit: Many years have passed and this below answer is no longer true. See the comments.
I'm afraid there's none. I am following Rust ecosystem and I have never seen even a mention of anything like that. On related note, I think the comments should be in the code, and if you writing open source code in Rust I'd advise to stick with the standard ways of doing things, just for the sake of other people. Eg. I am a vivid advocate of tab indentation as opposed to spaces ("Indent with tabs, align with spaces"), yet because Rust community settled on (clearly inferior :) ) spaces, I use spaces in my Rust projects. It doesn't fit my preferences, but after getting over it, it makes mine and other people lives easier when cooperating.
As a workaround, I would suggest making your editor just aggressively fold comments.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 3 years ago.
Improve this question
I will be writing a small grammar to parse a text file, the grammar can be a bit large so I want to read it with highlight.
I know it's a bit off-question but find this using google is very hard. What else place is better than ask to this to a lot of experient programmers.
Sort of. There's this answer for Emacs. Apple hosts a yacc syntax file for vim. Based on what's mentioned for this archive, Kate may also handle yacc, but I can't find a specific confirmation.
And yes, I'm mixing straight BNF with yacc. The pickings were slim enough that it seems like a reasonable leap, and it might not be too hard to hack the yacc-specific parts out of the syntax descriptions.
For BNF you could use IntelliJ from JetBrains with Grammar-Kit plugin.
EBNF support seems not included at the moment.
Here is another one: https://github.com/rochus-keller/EbnfStudio/blob/master/README.md.
It supports syntax highlighting, inline warnings, symbol navigation and cross-referencing. The grammar is automatically analyzed for syntax errors, missing non-terminals and left recursion while editing. The grammar can also be checked for LL(1) ambiguities and the effectiveness of conflict resolvers.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I'm a jack-of-all-trades-master-of-none programmer and as I jump around languages, quality consistent documentation is becoming more and more important to me. I've recently been using Doxygen, but Wikipedia reveals the usual ridiculous list of similar frameworks.
What is your favorite documentation generator and why? (Vote where you agree to keep it tidy!)
I use different files written in MediaWiki MarkUp, since this is easy to learn for everyone. I convert this to HTML and a CHM file, and to LaTeX for the PDF documentation.
This was the most painless way for me to generate Online documentation AND printable documentation in one strike with a simple way of input.
The tools I use are org.eclipse.mylyn.wikitext with a custom DocumentBuilder for LaTeX, the Microsoft Help compiler (which sadly only runs on windows), and a LaTeX distribution.
EDIT: I managed to get the Microsoft Help compiler running with Wine, so my Linux build server is now able to create the whole documentation automatically.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
what tools do you use to create programming flowchart/documentation from VB.NET source code? There are absolutely no comments/documentation at present. I am a beginner, i.e. I tried Sandcastle but it is way over my head and could not get it going, not even with GUI.
Fatesoft's CodeVisual To Flowchart is OK but it is almost the same as the code and I still don't understand the code.
Convert VB.NET to Csharp using http://converter.telerik.com/
Use Code Rocket to both generate documentation and flowchart http://www.rapidqualitysystems.com/Products/CodeRocketNET
You can use the built-in XML documentation, described here
I have always enjoyed the output of doxygen
And now I read that you need it for VB .... sigh
I guess you can look at it and think about how awesome it would have been to use ;)