Overview
Examples
Screenshots
Comparisons
Applications
Download
Documentation
Tutorials
Bazaar
Status & Roadmap
FAQ
Authors & License
Forums
Funding Ultimate++
Search on this site
Search in forums












SourceForge.net Logo
Home » Community » PR, media coverage, articles and documentation » What about adding comments to the examples in the wiki?
icon5.gif  What about adding comments to the examples in the wiki? [message #1489] Mon, 06 March 2006 16:42 Go to next message
santiago is currently offline  santiago
Messages: 13
Registered: March 2006
Location: C�rdoba, Argentina
Promising Member
so people can add comments in the sourcecode or clarify some of it. Even if u++ is easyer than anything else, the lack of comments in the sources make it pretty hard to read to someone who is not an advanced c++ programmer.

Well, it's just an idea.

[topic title edited by fudadmin...]

[Updated on: Mon, 06 March 2006 17:12] by Moderator

Report message to a moderator

Re: What about adding comments to the examples in the wiki? [message #1492 is a reply to message #1489] Mon, 06 March 2006 17:18 Go to previous messageGo to next message
fudadmin is currently offline  fudadmin
Messages: 1321
Registered: November 2005
Location: Kaunas, Lithuania
Ultimate Contributor
Administrator
What if to create a separate repository with comments? Because how do you update source changes in wiki?
Re: What about adding comments to the examples in the wiki? [message #1493 is a reply to message #1492] Mon, 06 March 2006 17:25 Go to previous messageGo to next message
santiago is currently offline  santiago
Messages: 13
Registered: March 2006
Location: C�rdoba, Argentina
Promising Member
Don't know if there is a way to do that with all the code, but what i was saying is just to do it with the examples, not all the sources.
Re: What about adding comments to the examples in the wiki? [message #1494 is a reply to message #1493] Mon, 06 March 2006 17:31 Go to previous messageGo to next message
mirek is currently offline  mirek
Messages: 13986
Registered: November 2005
Ultimate Member
santiago wrote on Mon, 06 March 2006 11:25

Don't know if there is a way to do that with all the code, but what i was saying is just to do it with the examples, not all the sources.


There already exists effort about documenting examples.

E.g.:

http://upp.sourceforge.net/examples$uppweb$HelloWorld$en-us. html

I think nothing prevents the community to continue doing so.

Personally, I prevent this style of explanation to comments in the code, however I am open to commented examples.

Plain english: If you want to document examples, do it and post results here;)

Mirek
Re: What about adding comments to the examples in the wiki? [message #1496 is a reply to message #1494] Mon, 06 March 2006 17:59 Go to previous message
fudadmin is currently offline  fudadmin
Messages: 1321
Registered: November 2005
Location: Kaunas, Lithuania
Ultimate Contributor
Administrator
luzr wrote on Mon, 06 March 2006 16:31



Plain english: If you want to document examples, do it and post results here;)

Mirek


E.g in "extra libraries" category.

btw, forums, usually, have better searching capabilities. And you can see immidiately all new postings. That's why I don't like wiki's anymore...

[Updated on: Mon, 06 March 2006 17:59]

Report message to a moderator

Previous Topic: FreeBSD port
Next Topic: Ultimate++: is it a platform or framework?
Goto Forum:
  


Current Time: Wed Jun 19 02:21:34 CEST 2024

Total time taken to generate the page: 0.02193 seconds