U++ forum: Welcome to the forum

Status & Roadmap

Authors & License

Funding Ultimate++

Search on this site

Search in forums

Home » Developing U++ » U++ Developers corner » is there U++ coding style reference?

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Return to the default flat view

Create a new topic

Submit Reply

Re: is there U++ coding style reference? [message #27745 is a reply to message #27738]

Sat, 31 July 2010 22:07

dolik.rce is currently offline

dolik.rce
Messages: 1791
Registered: August 2008
Location: Czech Republic

Ultimate Contributor

dolik.rce@gmail.com

mdelfede wrote on Sat, 31 July 2010 00:05

dolik.rce wrote on Tue, 27 July 2010 00:16

..........
and that the code should be clean without unnecessary comments Smile

Smile

The point there is to define what's "unnecessary" and how many years you'd like to remember what your code do without having to re-examine it for a week...... I'm still thinking that over-commenting is better than under-commenting.

Same discussion in as wine development. "No unnecessary comments", than just a bunch of people (4-5, I guess, among hundreds of wine contributors) can understand what the hell is happening inside gdi core code. Bah.

Max

Hi Max!

Proper documentation does not have to be written as comments. Theide is actually very good at it. The topic++ system let's you describe each functions inputs, outputs and also how it works in "reference" section of documentation, which can be swiftly shown in code editor just by moving the mouse pointer to the squares on the left side gutter. Wider ideas and concepts should be in "implementation" section and end user manuals in "app" section.

I am well aware that writing documentation this way is not as simple and fast as just typing the comments into the code. But I prefer the little extra work if it keeps the code clean.

Also, well named functions and a good structured code can make wonders Wink

Wink

That said, I agree that non-documented code that is not understandable to anyone is useless. I just wanted to point out that there is more than one way to do it Wink

Wink

Best regards,
Honza

Report message to a moderator

Send a private message to this user

[Message index]

		is there U++ coding style reference? By: kohait00 on Mon, 26 July 2010 23:01
		Re: is there U++ coding style reference? By: dolik.rce on Tue, 27 July 2010 00:16
		Re: is there U++ coding style reference? By: kohait00 on Tue, 27 July 2010 08:19
		Re: is there U++ coding style reference? By: dolik.rce on Tue, 27 July 2010 11:06
		Re: is there U++ coding style reference? By: kohait00 on Tue, 27 July 2010 11:24
		Re: is there U++ coding style reference? By: mrjt on Tue, 27 July 2010 12:02
		Re: is there U++ coding style reference? By: kohait00 on Tue, 27 July 2010 13:07
		Re: is there U++ coding style reference? By: dolik.rce on Tue, 27 July 2010 14:56
		Re: is there U++ coding style reference? By: kohait00 on Tue, 27 July 2010 16:25
		Re: is there U++ coding style reference? By: koldo on Thu, 29 July 2010 10:10
		Re: is there U++ coding style reference? By: dolik.rce on Thu, 29 July 2010 13:44
		Re: is there U++ coding style reference? By: mrjt on Thu, 29 July 2010 14:10
		Re: is there U++ coding style reference? By: mdelfede on Sat, 31 July 2010 00:05
		Re: is there U++ coding style reference? By: dolik.rce on Sat, 31 July 2010 22:07
		Re: is there U++ coding style reference? By: mdelfede on Sat, 31 July 2010 23:00
		Re: is there U++ coding style reference? By: kohait00 on Mon, 02 August 2010 09:06
		Re: is there U++ coding style reference? By: mrjt on Mon, 02 August 2010 11:21
		Re: is there U++ coding style reference? By: kohait00 on Mon, 02 August 2010 11:39
		Re: is there U++ coding style reference? By: koldo on Mon, 02 August 2010 14:59
		Re: is there U++ coding style reference? By: kohait00 on Mon, 02 August 2010 15:34
		Re: is there U++ coding style reference? By: kohait00 on Tue, 03 August 2010 11:24
		Re: is there U++ coding style reference? By: mrjt on Tue, 03 August 2010 12:40
		Re: is there U++ coding style reference? By: kohait00 on Tue, 03 August 2010 12:50
		Re: is there U++ coding style reference? By: mirek on Thu, 05 August 2010 12:50
		Re: is there U++ coding style reference? By: kohait00 on Thu, 05 August 2010 12:53
		Re: is there U++ coding style reference? By: mr_ped on Tue, 03 August 2010 13:05
		Re: is there U++ coding style reference? By: dolik.rce on Tue, 03 August 2010 13:39
		Re: is there U++ coding style reference? By: kohait00 on Tue, 03 August 2010 15:58
		Re: is there U++ coding style reference? By: mr_ped on Tue, 03 August 2010 17:28
		Re: is there U++ coding style reference? By: kohait00 on Tue, 03 August 2010 17:34

Previous Topic:	using Ctrl::Add; required for templates / overloaded virtual functions
Next Topic:	dll instead of exe

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

PDF

]

Current Time: Wed May 14 17:28:26 CEST 2025

Total time taken to generate the page: 0.02766 seconds