What convention do you use to comment getters and setters? This is something I've wondered for quite some time, for instance: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float salary(); I always find...
Hi, my webapp has registered users and it has articles, blog posts, gossips too. For all these resources I've a polymorphic Comment model which is listed below. id content commentable_id commentable_type user_id created_at updated_at 1 Frist comment 2 Article 1 .... 2 Second comment 3...
I see so many PHP comments in the format of: /** * (c) Copyright Someone 2009 * legal crap * blorp */ Is this just by convention, or is there a reason? I thought it was just a way that some people did it, but I am now wondering after I discovered that my syntax highlighter does this: This only happens when I've started to use th...
I am working on a website in PHP where people can make comments similar to a blog, and I only want particular tags to be allowed. Are there any pre-built libraries that process comments and produce valid XHTML Strict code? I would need to do this in JavaScript so I can generate a live preview like Stack Overflow, plus in PHP before savin...
Hi, I'm using Par (in linux) to get nice comments formatting quickly. The problem is that now I want to introduce comments that include some international characters, like áéíóú or äëïöü... The program Berkeley Par considers these international characters as 2 ASCII characters (I believe) and it outputs the comments somehow broken beca...
Hi, our stored procedures have developer comments and headers and as part of our deployment process we would like to remove these from the customer copy. Is there a method of achieving this within SQL Server 2005 or with another tool? ...
I'm finishing up some of my first C# classes and even though the original code I inherited is completely void of comments, I always put javadoc comments on my methods when I was writing java and my code currently looks strange without those blocks. I normally formatted my comments by using the "Insert JavaDoc" command in Eclipse, which ...
http://java.sun.com/docs/codeconv/html/CodeConventions.doc4.html#286 I was reading the above section of Java coding convention and started to wonder why it says "// comment.....shouldn't be used on consecutive multiple lines for text comments" Copy pasted the relevant section here for convenience: The // comment delimiter can comment ...
Would just like too see what peoples Stored Procedure/Function etc comment headers look like (so post your examples)...I've only really seen what the SQL Server Management Studio creates but am interested in what other peoples look like...the formatting, characters used, procedure information/details etc I guess are what really makes the...
I have an ASP.NET app that permits Word 2007 document uploads. Once they are uploaded I'd like to parse out the document text and also any comments made by reviewers. I'd like to be able to get the comments and the commenter initials/name. Are there free libaries to do this? I prefer not to automate Word as this process needs to be some...
I'm going through a Django book and I seem to be stuck. The code base used in the book is .96 and I'm using 1.0 for my Django install. The portion I'm stuck at is related to Django comments (django.contrib.comments). When I submit my comments I get "Comment post not allowed (400) Why: Missing content_type or object_pk field". I've fo...
I just had a situation where I was reading some code while working on a bug and I noticed an incorrect comment (the code did not do what the comment said it did). I just thought "hmm, ok" and went on working on the bug. About an hour later I was back at that line of code, having determined that it had caused the bug. In fact, if the c...
I'm a big fan of GhostDoc's automatic comment generation in Visual Studio so am looking for an plugin that does the same job with my Java code in Eclipse. Any recommendations? ...
I have Commenting system in my app. For a single video entry anyone can post a comment and someone else can post reply to that comment and replies, cannot have thier further reples, similar to StackOverflow is doing (1 Answer, and thier 1 or more replies). I want the similar functionality what SO has, Let's I have the following HTML <...
/*/ comment here do some thing. /*/ do some thing. //*/ Why people write code like that? Is this a good practice? ...
(Now that Django 1.1 is in release candidate status, it could be a good time to ask this.) I've been searing everywhere for ways to extend Django's comments app to support authenticated comments. After reading through the comments model a few times, I found that a ForeignKey to User already exists. From django.contrib.comments.models: ...
as the title asks ...
How could I use ruby to extract information from a table consisting of these rows? Is it possible to detect the comments using nokogiri? EXTRACT LINK 1 EXTRACT DESCRIPTION EXTRACT LINK 2 Mr P 1 ...
Hi everyone! This is one of the headers I found in WxWidgets and I like it. I wonder if there is a way to insert in all my source files a header like this and maintain it automatically updated? It includes two properties of SVN which I am aware of. ///////////////////////////////////////////////////////////////////////////// // Name: ...
I know there are many different standards for PHP code inline documentation. Here's what I mean by inline documentation, and please correct me if there is a better term: /** * This is the description for the class below. * * @package my-package * @subpackage my-subpackage * @author my-name * @version my-version * ... */ class ...