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.
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 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 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.
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
Background
There is a hardware project going on. A hardware accelerator has been being developed by a team of students but there is no general documentation.
There are READMEs here and there, some docxs and in-code (Verilog, C and Lua) comments, but nothing else. The code is written with Vim, versioned with Git and Markdown is our friend, even if we are not on Github (yet).
Since this “thing” is growing, I feel the necessity of writing down something (user manual? developer notes?) but I don't know where to start.
Question
When someone feels the urge of documenting his project, where does it start?
More specifically, what are the generally accepted criteria to do it and what are the best tools?
My hypothetical answer
We quite clearly need both a developer and user manual. One with details of the algorithmic solutions, the other... like for monkeys.
About the tools, I believe that something like a Github Wiki would work fine, but (1) we are not on Github and (2) wouldn't be LaTeX a better way of writing stuff in order to publicise it, eventually. I know we can get our Markdown rendered in a printable way with http://www.cocowrite.com/, but is it the most efficient solution? LaTeX would be a nuisance for collaborative editing and online HTML publishing.
A partial answer can be found here: “What tools are used to write documentation?”.
Second part of the answer can be found here: “What amount of documentation is needed for a non-trivial one-man software project”
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 8 years ago.
Improve this question
Are there any IDE's or editors that support Mercury besides emacs?
Distributed with Mercury is a syntax highlighting file for vim.
This is the only official editor support. See the vim directory in the compiler's source distribution.
People say that prolog-mode for Emacs also supports Mercury, I tried this and discovered that it didn't handle Mercury specific syntax at all, and therefore was no better than using any other emacs mode.
Personally I use vim with syntax highlighting.
Codeblocks could probably be made to work with Mercury. It doesn't directly support syntax highlighting for this language but you can create a custom lexer for it. Getting codeblocks' build system to work with the mmc compiler is just a matter of tweaking the 'advanced options' under Compiler and debugger settings.
We have recently released a simple plugin for eclipse to help editing Mercury files and using along Java projects. Please take a look at it if you have Mercury under Linux and meets your requirements. Any feedback is welcome. :)
You can find it here: http://kai.mercury.mind-era.com
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.