Hi I have like 50 pages of code that I should write comments to it ... Can you guys show me the best way. I meant I need you to write me a sample ... the comments should contain nearly everything (classes, constructors, attribute, methods, events, functions) ...
I recently started working on a small CMS. I usually develop .NET applications in C#, and I'm very used to commenting my fields and methods. My friend told me earler that having comments in PHP scripts is quite bad, since PHP is dynamic and parsed when requested, so having to parse the comments will take longer. Does this statement ap...
Does Eclipse have a hot key to comment a block? and to uncomment a block? ...
my python code is interlaced with lots of function calls used for (debugging|profiling|tracing etc.) for example: import logging logging.root.setLevel(logging.DEBUG) logging.debug('hello') j = 0 for i in range(10): j += i logging.debug('i %d j %d' % (i,j)) print(j) logging.debug('bye') i want to #define these resource consumi...
Is there a syntax for documenting functions which take a single configuration array, rather than individual parameters? I'm thinking specifically of CodeIgniter-style libraries, which use a mechanism similar to this: <?php // // Library definition // class MyLibrary { var $foo; var $bar; var $baz; // ... and many more vars......
/* #define FOO */ #ifdef FOO #define BAR "pirate" #else #define BAR "ninja" #endif int main() { printf(BAR); getchar(); } In this code FOO is not defined (Visual Studio 2008). I assume that comments are processed first, then preprocessor, and then code. Are comments always processed before the preprocessor? Is this part of a standar...
Hello! I am building my own blog, for various reasons - mainly for experience building with various tools - but also because that way I can have a blog that thinks like me ;). I have implemented a very narrow authentication system in which users can log in using Open ID. I have a classic log in page - if a new user logs in i ask them f...
Hello all, Quick question. How would I go about displaying comments to a static page from a comment box on a blog page where we are capturing name and email address and a short comment. One page would have the comment box and the static page will have the comments. Any help would do... Thanks, ...
I've got the following Perl code which makes a DBI call: my $artsql = q{ *** SNIP A BUNCH OF SQL *** where a.article_id != ? and at.type_name != 'List Element' -- don't get list children and aw.flowstate = 'Published' and a.visible_as_article = 1 } ...
I've got lots of source code files written in various languages, but none of them have a standard comment at the top (sometimes even across the same project). Some of them don't have any header comment at all :-) I've been thinking about creating a standard template that I can use at the top of my source files, and was wondering what fi...
Can anybody help me understand how this string tokenizer works by adding some comments into the code? I would very much appreciate any help thanks! public String[] split(String toSplit, char delim, boolean ignoreEmpty) { StringBuffer buffer = new StringBuffer(); Stack stringStack = new Stack(); for (int i = 0; i < toSplit....
Hai guys, I ve seen people including comments in their program.. Is it to improve inter-programmer communication and code readability, by explicitly specifying programmers’ intentions and assumptions? Should comments be in technical terms rather than in natural launguage terms? How to use comments as effective as possible? Is it reall...
I have a page with IE conditional comments in head section, nothing fancy just: <!--[if IE 7]> <link rel="stylesheet" href="css/IE7.css" type="text/css" /> <![endif]--> As I'm at work ;) didn't have a chance to setup testing page yet, but long story short it works as expected when JavaScript is on. When JS is off IE dosen't seem t...
Using rails 2.3.2 I have a partial _foo.rhtml that begins with a comment as follows: <% # here is a comment %> <li><%= foo %></li> When I render the partial from a view in the traditional way, e.g. <% some_numbers = [1, 2, 3, 4, 5] %> <ul> <%= render :partial => "foo", :collection => some_numbers %> </ul> I found that the <li> and ...
If so, what is your policy on doing so? Do you claim copyright/trade secret for ALL source code files or do you claim copyrights for all and Trade Secrets for only those that contain Trade Secrets? Can you post sample comment blocks with the legalese and how you arrived at it? I bring this up, because some time ago, when i worked for ...
I found following diagram from http://webkit.org/coding/major-objects.html. Is there a tool can draw graphics using characters like this? +---------+ | Chrome | +----+----+ | +---+---+ +----------+ | Page +---->| Settings | +---+---+ +----------+ | +-------------------------- ... other Frame objects...
What is the best way to put comments in your code? I see at least three different ways: 1: int i = 10; //Set i to 10 2: //Set i to 10 int i = 10; 3: int i = 10; //Set i to 10 The disadvantage of using the first method is that many people use tabs instead of spaces, and doing so will cause comments to become severely misaligned w...
I am new to JSON. Are there any methods in JSON parser to remove the comment characters from a response. Eg. //{"response":"success"....... its SBJson for iPhone. from http://code.google.com/p/json-framework ...
I'm working on a C project that has seen many different authors and many different documentation styles. I'm a big fan of doyxgen and other documentation generations tools, and I would like to migrate this project to use one of these systems. Is anybody aware of a tool that can scan source code comments for keywords like "Description",...
So on our site we currently have a textarea for commenting on certain items. The site uses AJAX so the user can press the button and see their message fade in (Imagine a Facebook style commenting.) The jQuery/AJAX: $(function() { $("input#comment_submit").click(function() { var comment = $("#comment_box").val(); var dataString = 'comme...