While editing, building up, or cherry picking from SQL statements I can find myself interacting with one of four popular database tools. I have been resorting to single line commenting for DB2 and Informix. I have created macros in vim to make this slightly more efficient but I was wondering if I am working too hard. ...
How do I comment blocks of code in Eclipse on a Mac? ...
I'm quite familiar with PHP dockblocks since it's been my job for the last 15+ years. /** * Description * * @tag bla bla * @tag more bla bla */ What I'm trying to understand is if there is a standard like that for Delphi and/or FreePascal. From my analysis on an awful lot of code I never seen any, but I could be dead wrong....
I talk about source-code-comments, that explains what happens on the next lines of code, not Javadoc/Doxygen-comments (that comment on the interface). Comments can make your intention for the code clearer, but on the other hand they could be redundant or even worse outdated (code was changed without changing comment). ...
How much do you use the XML comments in your code files, and how do you use them? I've seen that you can use them to generate XML documentation, but can this XML documentation be used to generate an HTML help file or schema file for your code? Also, have you used any auto-generating comment tools (i.e. GhostDoc), and what are your impre...
I imagine that we all (when we can be bothered!) comment our interfaces. e.g. /// <summary> /// Foo Interface /// </summary> public interface Foo { /// <summary> /// Will 'bar' /// </summary> /// <param name="wibble">Wibble factor</param> void Bar(string wibble); } Do you also comment the implementation (which may...
Does anyone know of any tools that allow you to extract comments directly from a .cs file in to some simple text or even the clipboard? Even better if such a tool could work at the method level too. I am not looking for something like Sandcastle that works at build time, I am looking for something that works on single source code files....
Hi everyone, I'm just wondering if anyone knows of a class that exists for handling user comments already. I can always write my own, but I figure I wouldn't re-invent the wheel if there is one out there. Id like to be able to display a comment form, manipulate/validate/sanitize user input, and possibly more functions such as inserting...
Has anyone seen an editor/IDE that shows WYSIWYG comments inside the code? I have seen some that show the docs of an element in a separated tab/windows, but not together with code. For example, a JavaDoc comment would be much clearer and easier to edit if it had no tags and could be edited like a snippet from a normal text document. /**...
How do I generate a default comment for cvs? I'd like every checkin comment to start with "Change #: " and be available for the user to edit. I know this can be done globally in the repository. Can it also be done as a single user on the client side? I am using command line cvs. We already have verification that the checkin starts...
I'm wondering if people have a standard format for comments in their code. Not things like xml comments for a method or class but rather comments within a method. See also: Is there a standard (like phpdoc or python’s docstring) for commenting C# code? ...
Can any one suggest what is the best way to write good code that is understandable without a single line of comments? ...
Hi, I noticed that in Java(doc) there exists something like @inheritDoc, so that comments from the nearest inheritable class are explicitly copied. Does there exist something like this in .Net? I know this can be achieved with GhostDoc. The downside with GhostDoc is that changes to "base" comments are not manifested... ...
I'm involved in a prototype development. We can't say that it's completely prototype development. It's partially following the processes defined within the organization. As far the customer concerned it's a prototype development. The problem is documentation. We don't have any time estimated and scheduled to prepare the architecture des...
I'm looking for a way to properly comment my stored procedure code so that I can extract the information into useful documentation ala something like XDOC (or C# equivalent). Something that's preferably lightweight would be ideal. ...
Which tricks, hints or shortcuts do you use regularly when you document your sourcecode? What type of comment does help you most (or is most desired) when looking over a piece of sourcecode? For an example, we always use date, shortcut of name and a +, -, * (added, deletet/commented, modified) and then some description: // 30.04.09 PL...
I'm working on a PHP app that has several objects that can be commented on. Each comment can be voted on, with users being able to give it +1 or -1 (like Digg or Reddit). Right now I'm planning on having a 'votes' table that has carries user_id and their vote info, which seems to work fine. The thing is, each object has hundreds of co...
Hi there I come from writing PHP code, and there I was using PHPDoc standards, in order to write comments in the code. Now I'm trying to learn C/C++ (I'm using Visual Studio 2005), but I also wish to write good comments. Is any standard to use or/and a tool which will automatize the documentation construction later? many thx:) ...
Well as the questions says... An equation might be more meaningful in its math-notated form than it is in code. Being able to put math in comments could improve readabibity on my projects. In .NET btw. ...
I'd like to find some very capable PDF tools or libraries. In particular, I'd like to be able to enable commenting, as Acrobat can do. Ideally this would be a Mac OS/X tool; failing that something usable from Python or Ruby would be good. I've already looked at pdftk, which doesn't appear to know about comments iText, which frankl...