|
We had lots of discussion about this at work too, about how extensively code should be commented, and if at all.
First there is a difference between commenting and documenting code. The latter you probably need to do anyway, at least for public APIs. Besides that, imho some visual indicator on top of each function / class etc makes it easier to navigate through code. So a short block on top of each function can act as kind of a separator (like headlines in normal texts), that allows to quickly see where a function starts. So (meanwhile) I add at least a single line with dashes on top of each function, and find that quite useful.
As for comments, I agree with those people, who say code should be written in a way that comments are not necessary. Means: Use names that say what it is about rather than comments, split complicated constructs into multiple steps, even if it appears less "cool" (functional programming!) etc.
However, there are cases, where comments are a good idea. Not just to explain some parts of the code that are hard to understand, but also to indicate that something might look like a bug or a wired construct, but is actually intended. Like this JS:
const a = parseInt(someString, 10);
if (!(a > 0))...
One might think "Wtf? Why not if (a <= 0)...?", and forget, that the former also takes care of NaN.
So my personal guideline:
- Write code that doesn't need comments.
- Comment to avoid misunderstandings.
- Document your code.
|
|
|
|
|
Thanks for the point for use in js to avoid NAN. I did not know that.
|
|
|
|
|
|
I came from a background of profusely commenting code to a job(last year) where comments are explicitly discouraged and code reviews will be failed if there is a comment.
There are a few cases where comments are allowed - for very complex issues - but other than that comments are not allowed.
I struggled at first but it has actually made me a better developer as I now have to read and understand what others have don in code rather than just read a comment and think I know what a method or stored procedure does.
So I am a convert to sparsely commented code as I tend to agree with the principle that writing comments means that you have to keep the comments up-to-date and it has encouraged me to both write better code and understand other peoples' code.
“That which can be asserted without evidence, can be dismissed without evidence.”
― Christopher Hitchens
|
|
|
|
|
GuyThiebaut wrote: comments are explicitly discouraged and code reviews will be failed if there is a comment.
Ah, so you work in Hell. Could you put in a good word with your CEO? I might end up there so...
* CALL APOGEE, SAY AARDWOLF
* GCS d--- s-/++ a- C++++ U+++ P- L- E-- W++ N++ o+ K- w+++ O? M-- V? PS+ PE- Y+ PGP t++ 5? X R++ tv-- b+ DI+++ D++ G e++>+++ h--- ++>+++ y+++* Weapons extension: ma- k++ F+2 X
* Never pay more than 20 bucks for a computer game.
* I'm a puny punmaker.
|
|
|
|
|
den2k88 wrote: Ah, so you work in Hell.
That's what I thought to begin with.
However the advantage of no comments is that that the code needs to be really tight and well written and the code reviews help that too - you cannot rely on the comments to make sense of the code so it needs to be well coded.
It has also helped me read and understand other people's code much better.
I am a convert.
“That which can be asserted without evidence, can be dismissed without evidence.”
― Christopher Hitchens
|
|
|
|
|
Hi,
Im getting Http 403 forbidden Error -You do not have permission to access /' on the server while navigating from one page to another page only for few users.
There is no log in EVentviwer and IIS logs for this 403 error.
Its working as expected without any issue while we try in individual web servers. whhile access through internet it throws error.
if there is an issue in Load balancer server, all users should get the error,
Since we are getting the issue only for few users dont have any clue where is the problem.
Please assist here with your inputs/suggestions.
|
|
|
|
|
AS it says it denies permission, have you validated if a user requires access permission and have it to access that page? IS that folder secured by authorization?
modified 20-Sep-20 21:01pm.
|
|
|
|
|
Showing error to run the application.
"http://localhost:49474/GDrive%20Uploader/authorize/?code=4/WvzVOsLjDEdawb2Q4JjRv5toASHiT9yh5aOm_7bgqic#"
This site can’t be reached
localhost refused to connect.
Search Google for localhost 49474 GDrive Uploader authorize
ERR_CONNECTION_REFUSED
Kindly suggest/help. Thanks a lot in advance.
|
|
|
|
|
Raja Chakraborty wrote: This site can’t be reached
That explains the problem. What can we do?
There are two kinds of people in the world: those who can extrapolate from incomplete data.
There are only 10 types of people in the world, those who understand binary and those who don't.
|
|
|
|
|
After over 20 years I was just laid off from my job and now I am lost trying to navigate to a new job. I am(was) a developer, mostly C++ but a little C# and MySql experience. I am mostly self-taught since my major was actually Management Science. I kind of fell into coding and taught myself along the way enough of Java, JavaScript, etc. to complete my current assignment. With that being said, I will not be able to answer questions on a coding interview since I didn't learn the correct terms. I always wanted to get into mobile development but there was no opportunity for this in my former position. I would like to make the switch now but everyone wants years of experience which I obviously do not have. I don't have much in the way severance so I need something in a few months. Any advice or ideas? I only saw one job posting so far that said they would teach you how to become a mobile developer but the posting has been up over a month now and I never heard back after sending my resume. What I was doing before was so specialized (converting data from various outside sources into a format our in-house program wanted; developing applications to display and edit that data; developing an application to interact with Google Earth so the display could be saved to a jpg to display later; etc.) it doesn't really transfer. Any constructive feedback would be helpful.
|
|
|
|
|
I'd start by buying a keyboard with a working Return key. 
"These people looked deep within my soul and assigned me a number based on the order in which I joined."
- Homer
|
|
|
|
|
![Rose | [Rose]](https://codeproject.freetls.fastly.net/script/Forums/Images/rose.gif)
#SupportHeForShe
Government can give you nothing but what it takes from somebody else. A government big enough to give you everything you want is big enough to take everything you've got, including your freedom.-Ezra Taft Benson
You must accept 1 of 2 basic premises: Either we are alone in the universe or we are not alone. Either way, the implications are staggering!-Wernher von Braun
|
|
|
|
|
I'm trying to bulletproof a contract for some freelance work. However, I can't seem to find any template that includes a clause on penalising a client for any delay they may cause to the project i.e. takes unreasonably long time to respond to clarifications, grant necessary access, etc.
How should this clause look under the contract and under which section? Any sample that you could share perhaps?
|
|
|
|
|
So I graduated last semester with a degree in business, it it wasn't until my senior year that I got into the world of data and coding. First it was R code and then SQL. My buddy told me about a job he got for a company in coding and he has very little coding experience but very high level math skills.
I applied and during the phone interview they told me that coding answers need some work but are still interested in hiring me if I can get my skill up a bit.
I bought a Java Text book and the online question package. I am also looking at Ruby through some apps on my phone because I see that it's a lot easier and should teach me the basic blocks quicker.
To shorten this long story, I am running off to Greece for three months with my wife to visit her family and I want to take this break to really bunker down and work on my coding skills.
Any recommendations on what to focus on (the company has their own coding program but they want people who already understand let OOP concepts) if things don't work out with this company I would like to have a backup goal.
What is the demand in right now? What should I be focusing on?
|
|
|
|
|
According to TIOBE website (https://www.tiobe.com/tiobe-index/) the big five are now Java, C, C++, Python and C#. Concerning "learning OOP by doing" C# is in my view a good choice (but I might be biased a bit...) as it is easier to learn (even with a free Visual Studio 2015 Community Edition, of with a free SharpDevelop environment), than the other 4 ... But it depends on the preference at the company that you mentioned (perhaps it is doable just to ask them which programming languages they use ? ...) Any way, I think there are many opportunities for C# developers, so it is not a waste of time to learn OOP using C# as you have 2 targets at once: OOP + 1 modern language from the "big five"
Good luck with your study ...
|
|
|
|
|
Tachyonx has a great point. To expand on his, your SQL can be linked to C# skills and give you a big 'in' with businesses of all sorts. Databases connected to interfaces are always marketable.
|
|
|
|
|
What would you include on a list of “If all these things happened in my professional life in IT, just once, I could die happy”?
For example:
• The client approved my proposal without any changes.
• A meeting ended 20 minutes early.
• I built my own nerd cave.
• The project plan was fully documented. And they didn't add a single thing.
What would you add?
I'm going to collect these and create a (fun I hope) short article. I won't be quoting anybody, just using the wish list items. So please tell me what should be included!
|
|
|
|
|
I've been briefed to "jazz up" this web site. I can handle the structural and ergonomic work, but I'll need some help with the general aesthetics, e.g. I think the plain white background is a worse turn-off than an ice-cold shower. The repeated content of the sliding banner I will take care of with actual photos of the business in various common acts that are part of the operation, and stuff like "Quick Links" at the bottom of the page? I can't even!
Some free suggestions are welcome, but it could easily become a gig for you if I like your initial assessment. My client will have to like your estimate though 
[^]
|
|
|
|
|
Ouch! That's ugly! The white background doesn't bother me so much as that horrible mustard theme. Something a few shades darker perhaps? Good luck!
"Go forth into the source" - Neal Morse
|
|
|
|
|
Yes, and the half page wide "Free Quote" button in that same mustard. At least he has asked for more black and red, and the logo is black and white and that mustard, so my new black and white additions will match that, and the red add some sparkel.
|
|
|
|
|
CodeGroundOnlineTestingPlatform wrote: One reason is that it is completely overused and unoriginal.
As was the question.
CodeGroundOnlineTestingPlatform wrote: Choosing a weakness:
This kind of "advice" is the source of the problem you just painted. You do not choose one, you indentify one.
CodeGroundOnlineTestingPlatform wrote: Like Share Comment CodeGround Online Testing Platform is an online assessment and evaluation system that helps Recruiters conduct online screening tests to filter candidates before the interview process.
Marked as spam.
Bastard Programmer from Hell 
If you can't read my code, try converting it here[^]
|
|
|
|
|
Hi,
i was assigned with a task (new one for me actually) for automatic summary of company solutions.....
all what i could think of is number of projects, classes, functions, and number of lines used inside each one........
is this correct or what? also is there a tool to do it or should i do it manually???
when i googled it all what i got was about code map and code metric.
is there anything else?
P.S. I'm using VS 2015 Ent 2015
thank you
modified 6-Nov-16 4:57am.
|
|
|
|
|
Question looks like one better suited to Architecture forum.
|
|
|
|
|
Hakmeh Mohannad wrote: automatic summary of company solutions
What in the world does that mean?
Hakmeh Mohannad wrote: is this correct or what?
No idea because I have no idea what you need to do.
There are two kinds of people in the world: those who can extrapolate from incomplete data.
There are only 10 types of people in the world, those who understand binary and those who don't.
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
