Code comments

Dec 10, 2008 at 10:02 PM
From a brief look: Interesting. The idea of putting interfaces on the LING to SQL data model to keep the internally-genrated data classes, but free you from dependence on them is really good.

But:
Comment your classes, tell us what they do. Tell us why they exist. No comments, anywhere. How do you cope?
Turn on warnings as errors.
What about code Analysis? StyleCop? Resharper for unused using directives and other bits?

Can you somewhere list which features are in and which out? I see atom and RSS mentioned in the code. I'd like foaf, even thought hat's not core in blogs.
Dec 12, 2008 at 4:37 AM
I totally agree - this is a very interesting project, but comments or at least some high-level doc (what's an "area" and how does that impact the Uri space of the site etc) would be really useful. I'm all for reading the code and tracing through stuff, but some guidance would make it easier to know where to jump in.

Thanks!

Dave
Dec 13, 2008 at 4:20 PM
Also, I don't see a lot of test cases. What is the test coverage like in general?
Dec 16, 2008 at 8:05 PM
Edited Dec 17, 2008 at 10:56 AM
I'm sure you've seen Rob Connery's thoughts on Oxite by now.

I'll add my 2c : The folder Oxite\Data contains quite a few files. I would split this into
1) Oxite\DataInterfaces  Interfaces to "domain objects" that correspond to rows in tables on the db.
2) .. other. Or more than one other.

You have these lines all over the place in various forms:

            Config = (IOxiteConfiguration)ConfigurationManager.GetSection("oxite");
            IOxiteDataProvider dataProvider = Config.DataProvider.GetInstance();

Have you considered wrapping these up in a common method - would avoid the direct dependence on System.Configuration.ConfigurationManager, and provide a single point of change for introducing IOC?

Of cource with real IOC, the IOxiteDataProvider interface itself becomes unnecessary, since it's just a way to get the individual repositories.

Dec 17, 2008 at 8:04 AM
Ummm its an Alpha version people! And what ever happend to stepping thru code? I've spent an hour steping thru code and I already understand most of the how it all hangs together, i suggest you do the same and stop complaining. If you want a fully documented solution then wait for final release!!!

This is the problem with today's developers/architects too lazy to get your hands dirty work and too much emphasis on compliance & documentation!!!

Dec 17, 2008 at 9:28 AM
Edited Dec 17, 2008 at 1:18 PM
Point taken about stepping though - and I can do that now that the DB script is in place, I could not when I wrote the original post. But if you start with your comments only after you finish your code, you're doing it wrong.