Please allow my intro to properly define the scope of my question: I'm still very new to the programming world. This all started for me when I had an idea for a software program, but no programming experience. I ended up going the outsourcing route to get the program, and after almost a year, we do have it live and functioning. This ...
I'm looking for a "best practice" to document my C code. Like in any project I have some header files ".h" and the respective source file ".c" In the header file what kind of comment you put in? And in source files? The question arise up because since I commented well my header files, the c files looks like a mess. What's your best pra...
I'm using Drupal 6 and its core comment module. I want to run a custom funcion every time a user posts a comment, but I don't want to mess with the comment.module for obvious reasons. Is there a practical way I can do this in a custom module? If not, what are the alternatives as I don't want to write my own commenting system. ...
I am the technology director at a small nonprofit, and we are in the process of making a new website. We have several proposed mock-ups of different homepage designs, and need to receive input from our board members. Is there an online application/program/framework that will receive and organize user comments? I'm looking for somethin...
I have many .h file which contains many inline functions. And they configured for conditional compilation. In fact, this is a math library have reference and optimized codes. I'm putting some comments on here. There is a function prototype, and 2 implementations. Is this possible? void func1(); /*! Basic description */ void func1() ...
Sorry folks forgotten this one, I need to read the first "batch" of comment in a php file example would be: <?php /** This is some basic file info **/ ?> <?php This is the "file" proper" ?> I need to read the first comment inside another file but I have totally forgotten how to get the /** This is some basic file info **/ as a string ...
I'm finishing up a project I've been working on for a while, and am just putting on the final touches. One thing I would like to do is add class descriptions at the top of each class file (to help myself and other programmers figure out what's going on). My thought is to just use a bunch of '/''s to rope off a section for me to write ...
Hi guys, just a small query. I am working in VS 2008 and often i need to write a note in code like a reminder type. This note is in comment but is of multiple lines. i know VS used to provide summary option but now i am unable to find it . a+b; // this is my note // note continuing on next line // but dont want to writ...
I decided to show a breaking version of what I am talking about. It is not important how it messes up the layout, only that it causes the DIV element to be null.... <!-- [ top panel ] --><div id="top_panel"> <!-- -------------------------------------- --> <script type="text/javascript"> alert(document.getElementById('top_panel'...
Which method of commenting is most widely accepted or does it really matter? I have been using /** * (Method description) * @param * @return * etc */ However I have read of: Precondition: Postcondition: Is there a more 'professional' way of commenting? Thanks. ...
I was once working on a Java application dealing with unicode processing - and as usual to begin with, I write some code and test it, then comment out the working code and add some new lines., and this process goes on till I find the solution The exact issue I had was commenting out illegal Unicode strings. Some unicode wasn't working ...