comments

Reading MS word file in C# with comments

Hi, Currently i have a word document with comments added. The structure of the document is specified in the comment. The document contains embedded images. Now i need to structurally read the document based on the comments and create a html file. The problem is i cant capture the embedded image information currently. Comments c...

Eclipse Plugin or else for coding footnote

I love the Manning In Action Series. One of appealing area is that the code listing inside the book always has a footnote where there is a detailed explanation by a reference number. See below the example: So I'm wondering if there is an Eclipse plugin or online blogging service that allows footnote taking in the source code? ...

Database: Multiple tables or just one table?

For example I have photos and videos tables, I can comment on these, but when I send it to database which way is better? To have 2 tables for comments: photo_comments and video_comments Or to have 1 table comments and create a row inside the table like type and put there if it's a photo_comment or video_comment I think the 1 is faste...

Proper commenting for functional programming

I've been learning scheme, and I just realized that I don't really know how to properly comment my functional scheme code. I know how to add a comment of course - you add a ; and put your comment after it. My question is what should I put in my comments, and where should I comment for maximum readability and comprehensability for other p...

Django: Customizing the comments framework: accessing context user in custom form?

the goal is to render a comment form with an extra recaptcha field if the user is not authenticated. I'd like to extend the comments framework, making the contrib CommentForm dynamic, so the constructor checks to see if the context user is authenticated. But it doesn't seem like I can get the context user in the form without passing it...

RSS/Atom feed of Subversion commit comments

We have recently introduced version control in Subversion in our development cycle, and a team mate asked me today if it was possible to get all commit comments in an RSS feed. Since I think it's a pretty cool idea, I looked around in the Visual SVN Server option windows, and here on SO, but couldn't find anything relevant. (Most searche...

When are comments "too much", and when are they not enough?

There is an on-going minor debate where I work about the efficacy of comments within code. One of the leads instructed his developers not to use comments as they are too "old fashioned", and a couple of other developers indicated that they never use comments because they feel all they do is clutter up the code. I have always pretty much...

XML Comments not appearing in WCF Service

Hi I have a WCF service and commenting my operation contracts as below: /// <summary> /// Call to topup a card. /// </summary> /// <param name="topUp">The TopUp object which specifies the card to topup.</param> /// <returns>Returns a boolean indicating whether call has finished successfully. </returns> [...

Solution for comments for a Rails application

I'm introducing comments into a Rails application, and, being exceptionally lazy, I'm looking for a plugin to do it for me. I came across acts-as-commentable, but I didn't find much else. Acts-as-commentable seems fine, but it doesn't have support for threading. Of course, it wouldn't be too hard just to home-brew the entire thing, but ...

django threadedcomment setup

hi ..im trying to use django threaded comments however im stuck in how to correctly set values in this: {% get_comment_form for [object] as [varname] with [parent_id] %} {% get_comment_form for [app].[model] [object_id] as [varname] with [parent_id] %} {% render_comment_form for [object] with [parent_id] %} {% render_comment_form for [...

How to show general comments on function overloads.

I have created a function with some overloads. Now I want to add comments for each overload but not repeating summary content again and again. I only want parameter description to be given. i.e. /// <summary> /// Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control Should not be NULL. /// </summary>...

Explaining source code via "doc"?

Hi, I am using PHPDoc and JSDoc for my source code. I know that there are tools to build an API out of those docs. However, what I am wondering is that how is one supposed to explain complex code? Do I just use multiline comments inside functions rather than explaining in the PHPDoc/JSDoc? For example, consider this code: /** * Lorem...

Wordpress plugin to notify all users when there is a new comment.

Hi, I was wondering if anyone knew of a plugin that notified all users when an new comment was made. At the moment it only notifies the author of the post. Cheers. ...

How to parse css (stylesheet) comments (annotations)?

Hi! I have this idea, the user defines set of css rules with some comments (comments are simple annotations): /* @name Page style */ body { font: 16px/1.5 Arial; /* @editable */ backgorund-color: #fff; /* @editable */ } /* @name Section header */ h1 { font: 20px/1.2 Arial; /* @editable */ color: #c44 } I can apply this ...

Comments for my iPhone App

Hi, I have created my iPhone App and i must do a document like javaDoc in java but i don't find anything with google. I think that the comments have similar syntax but i'm not sure. (/* */) Can you help me? Thanks ...

MYSQl Optimize Table Of Blog Posts With Comments

Hi, Im making a mysql table which will be holding my blog posts and some of their information. I want to be able to add comments the the blog posts and have them saved in mysql. My question is weather I should make a table called comments and have all the comments there have the blog post id, so I would only select the corresponding com...

How do I comment a publicly visible type Enum?

How do I comment this Enum so that the warning does not appear? Yes I realize that comments are unnecessary, but if commenting is easy and it resolves the warnings then I'd like to do it. Warnings that appear: Missing XML comment for publicly visible type or member /// <summary> /// Conditional statements /// </summary> public enum Co...

Implementing Gravatar into custom Commenting System.

Hi guys! I'm in the process of coding my very first blog. With the help of various tutorials, and other forums I have managed to gather a semi-working code. Right now I have a code that takes and displays the comment, but the problem is I wish to display Gravatars beside each comment. I was just wondering how exactly I would go about im...

Displaying incorrect Gravatar

I posted on this site earlier on questioning how to implement Gravatars into my php blog. I got an excellent answer but I've had one issue. The code displays the incorrect avatar. Any help is appreciated. Code: <?php function get_gravatar( $email, $s = 40, $d = 'identicon', $r = 'g', $img = false, $atts = array() ) { $...

How can I diff two files, but ignore differences in Perl/C/C++ comments?

Hi, I would like to take the diff of two source code files, but I don't want it to report any differences for lines that only contain a programming language comment. The types of comments I would like it to ignore are: // ... # ... /* ... */ ...