|
_Maxxx_ wrote: I can't find this option
Go to "My Settings" -> "Newsletters & Emails".
In some cases, my signature will be longer than my message...
<em style="color:red"> <b>ProgramFOX</b></em> ProgramFOX
|
|
|
|
|
The final submissions are in for the Ultimate Coder Challenge.
Lee, John, George & Suresh, Sagar, Shailesh and Andreas have submitted their works, their creations, their results of endless sleepless nights and possibly a fair bit of cursing and we, the judges, have the task of picking the apps to pieces with a small pair of tweezers. Metaphorically.
The original task for the contestants is to "create apps that take full advantage of the performance advances, graphic excellence, touch and sensor technologies of the latest Ultrabook™ computers". That's fairly broad, and I would add that a critical component of the challenge is to showcase the Ultrabook.
The Ultrabook is a new device, the love-child of an ultra-light laptop and a tablet. The operating system of choice, and in fact the only one to currently take full advantage of the hardware is Windows 8, and Windows 8 fully reflects the Dr Jekyll and Mr Hyde nature of the unit. It's a laptop. Though if you ignore the keyboard and hold it awkwardly it's a tablet. Yet it's a PC. A fast, light, energy efficient, peripherally rich and accommodating computer that does everything you expect from a laptop, and oh so more.
To showcase an Ultrabook, then, one needs to showcase the operating system to allow the operating system to showcase the Ultrabook, and when I think of something being showcased I expect to see something unexpected, maybe contrived, but above all, something entertaining and possibly educational.
So I want to be entertained and educated by these applications. I want to run the applications and, from them, understand what an Ultrabook is.
Let's start.
LoveHearts is a social message game with a couple of games within the game. Lee went to extraordinary lengths to port his OpenGL based framework to DirectX, and succeeded, give or take having to downgrade a video driver. His application takes advantage of the touchscreen, light sensor, NFC, the compass and features such as notifications.
It's a technical marvel. It's a triumph of sheer bloody mindedness over common sense. It's a monument to perseverance. It is not, however, an application that makes any sense to me. You swipe the wrapper, you get a token, and a small piece of candy appears. You touch that (for wont of anything else to do) and it floats to the top of the screen. Touch an item at the top of the screen various actions can be taken such as sending a message, reading (and sending) jokes and poems, or playing a game. There is a bug in the app and sometimes, no matter what item up top I press, the train game appears which, after trying a dozen times and watching Lee's video, I still have no idea how to play. No matter what I do the train careens forward with a mind of its own.
The idea behind Shufflr is an interesting one. You are presented with a series of videos potentially of interest to you. The Ultrabook twist is that it would be touchscreen enabled and would use the tilt sensors to shuffle backwards and forwards between videos. Add to it the potential for transferring information via NFC, using the ambient light sensor to make it easier on the eyes, and maybe WiDi to throw the video onto your TV and you have a neat app.
In judging this application I came across several serious glitches: launching it would show the launch screen, then I'd be thrown back onto the Start screen. Launch again and it would tell me it was logging me in, and then I'm thrown out again. Rinse, repeat, and eventually after a few restarts I'm in. The first screen provides an overlay with the various gestures. This is incredibly important, and the #1 issue I have is that once you dismiss this screen you are unable to find it again. I was, frankly, lost trying to control the app. Shuffling the videos works fine, though pinch to zoom doesn't. Shaking works to reshuffle, but care must be taken when holding the Ultrabook on your lap because leaning even slightly will trigger a video swap. Too bad if you were enjoying the show. The two modes - DailyFix and Flipside - could be highlighted far more than they currently are. This, to me, is a failing of minimalist design: it took me a good half dozen uses of the app to realise that the " DailyFix FlipSide " words at the top left were actually links that, when clicked, changed the app mode.
One final niggle: when viewing the start screen, Shufflr displays video caps on the live tile. However, it doesn't brand the live tile with the Shufflr name so, among the dozens of tiles I have on my start screen, it's extremely difficult to spot the Shufflr tile.
BioIQ is a simple teaching game where you label the parts of, well, parts. A plant cell, the heart, eye and other internal gooey bits. It keeps its live tile updated but its primary nod to the Ultrabook is its touchscreen capability. For this app, that's really all that makes sense (unless they wanted to make it really hard and force you to slide the labels to the organs using tilt). It's an app that, when you use it, you don't even realise you're using a touchscreen laptop. That's not a bad thing.
Wind up football is an extremely simple, graphics heavy game with the rules "grab the ball, keep away from the mobs". Instructions are minimal, but as you play around you realise you can touch one of your team members on the screen, draw a line to that unit's destination and in a manner of speaking direct the play. However, the goal seems to be to avoid the other team while, at the same time, beating the daylights out of the other team by tapping on an icon when one of your units gets close enough. It uses touch, it uses the GPU, and uses the communications APIs to enable multiplayer action. It's extremely polished and solid, but the jury is still out for me as to whether this is the application that I would fire up first when showing off a new Ultrabook to a friend.
MoneyBags is an expense tracking application that focuses on being seriously productive rather than seriously fun. My initial experience with it was great - it's the only entry that's self packaged with an installer - but on activating the application with the supplied product key the application is stalled on the activation screen. Restarting got me past this, and then I was presented with a basic tour - always a nice touch.
The application takes advantage of the touchscreen, power states, GPU and the horsepower under the hood. Again, however, it's not an app that I would showcase as a prime example of what makes an ultrabook exciting. It does, however, have a trick up its sleeve: NFC communication so you can transfer transactions from your smartphone to the application. I am, however, one of the faceless mass of iPhone users who must put up with an NFC free device so I'm unable to test this capability.
A second issue that struck me was that, even though the application was touch screen enabled, it was most definitely not touch screen optimised. On the left hand side is a scrollable list of categories. There is a scrollbar, but one would expect that simply swiping on the list would scroll it. Unfortunately you need to touch and move the scrollbar which, on my screen, is about 2mm wide - significantly smaller than my big fat thumb. Scrolling often resulted in nothing happening, or worse, one of the categories being accidentally opened. Further touch issues were evident in the lower nav bar: the home and settings icons were way too small to be easily touched, and the other option labels, while bigger, were still on the uncomfortably small side. This is, unfortunately, an app better suited to a mouse than a touchscreen.
The language trainer, which I thought was a web-based HTML5 application, is in fact a Metro app written in HTML5. A standard PowerShell based install and a Start screen tile, and in you go. I chose the French lesson, since in Canada we're meant to be fluent in French and English, but evidently my French is not up to par with "rue" not being the correct translation of "street" and none of "siège, banc, or selle" being enough to satisfy "seat". You only get one try, and there are no hints, so it's a little frustrating to work out what it thinks the answer should be. The app uses touch screen input, but, as far as I can tell, no other Ultrabook features.
Judging finished this week and the points will be tallied and a winner announced. Good luck to all, and I take my hat of to all participants for dedicating their time and energy to entertaining us judges.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
The final round of updates has come so it's time to see what the developers have produced. Actual judging starts this week and until I sit down with the score card I'll keep my comments light and breezy.
Lee is done and his app takes advantage of an extraordinary array of Ultrabook functionality. Messaging, movement sensors, location, light sensors, the webcam, multi touch, graphics (to an insane degree), parallel coding, communications as well as a nice foray into InApp purchases. This is a man possessed. This is a man who needs sleep.
George and Suresh have summed up their 6 week journey with a few demo's of their app. 6 weeks, day in, day out, and they are done, with the added benefit that they get to demo via recorded video, rather than the traditional live demo that worked 100 times during rehearsal and failed in front of a studio audience. They have also covered a great issue regarding packaging and distribution. The standard dev way of distributing a Metro, sorry, Windows Store, app is via an installer power by PowerShell. It's very, very clunky so improvements in this area get them brownie points. They too have hit the gamut of Ultrabook features, so testing will be fun.
Shailesh at Clef Software is likewise done and their app is currently going through the store verification process. Ah, gotta love red tape. Although, you gotta love apps that are certified to be virus and malware free, too.
John has wrapped up with a plea to us hard, unforgiving and downright cynical judges that it's all about the experience, and not about the technical excellence of the code. As a coder I'm immediately offended. Technical Excellence or Die! As a user, and as a coder who has 9 million other coders constantly, unrelentingly, passionately picking apart my application, I totally and utterly agree. The pursuit of technical excellence can lead to a truly awful solution, because devs often forget that users are an integral part of the requirements.
Sagar provides a brief discussion of their use of always-on / always-connected. Again we're hearing of driver issues, and again the guys, like others, have spelunked into territory angels fear to tread and done a little driver hacking. I live for the day that drivers are a thing of the past.
Andreas has posted his final post on his efforts to convert a HTML5 app to the new Windows 8 UI design. No code or sample apps for now, so full judging will have to wait until next week.
So no more contestant blogs, and one final round of judging to go.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
The ultimate coder challenge is winding down and the contestants have made their penultimate post. Were it me doing the coding I'd still be at the planning stage, but well and truly ready to pull 7 all-nighters to get the thing done by next week's deadline. The six contestants are, however, made of sterner, or at least more organised stuff than myself.
Last week was the Intel Developer Forum so no blogs to review. Contestants and judges were too busy running around exhibit halls and consuming whatever freebies were available to do anything serious, though from the sounds of it secret elves back at home base kept the cauldrons bubbling. Nothing like a bit of tag team development.
So on to the challengers:
Lee looks like his app is fully baked. Actually Lee himself looked pretty baked in some of his IDF trip photos.
George & Suresh also seem to be at a good point with their app and they have added what I'd consider a killer Ultrabook feature to their app: NFC exchange of transactions from mobile devices to their MoneyBags Ultrabook application. This is the essence of what the Ultrabook enables: a completely new way of interacting with the device. It's not a computer that sits on your desk to do spreadsheets. It's a seamless part of your day and you interact with it in ways not possible with other devices. Well done, guys.
Shailesh discuss their experience in submitting their (desktop) app to the Intel AppUp store. One of the great features here is the in-App Unlocking API which enables unlocking additional game levels within an app. It's great to know these things are baked into the core.
John has waxed lyrical about what Ultrabooks mean. It seems like the week at IDF has enabled the contestants to understand completely the vision of Greg Welch, the father of the Ultrabook. Again, it's about providing an application that understands the context of the user. Where are they? How bright is it? Are they moving? What devices are near them? How is the user touching the device, and is he, as my hope has always been, about to try and kick the Ultrabook between a set of uprights on the footy field?
Sagar discuss their addition of GPS sensor info and multi touch. It's icing on the cake time for them.
Andreas discusses some touch additions to his app. He's using click events, but I can't help but wonder if touch and drag events would be more appropriate in this case. A click is an up/down event pair, whereas when you interact with a screen using touch it's often a down/hold/drag sequence. There are endless possibilities here but I guess I'll have to wait until next week.
They are close. They all seem pretty wrecked and/or extremely excited and wound up after IDF. Who can blame them.
One point I should make is that the units the developers, and us judges, are using are prototypes. They will never appear on a store shelf and are not what you would consider fully polished. Driver issues have been the biggest hurdle, as well as small issues between the versions of Windows 8 installed. Our units came with a version slightly earlier than the version available now, so the slight OS differences have also added to the excitement. This is truly living on the bleeding edge, but it's a very comfortable, well crafted, with a really nice rubbery cover on the top bleeding edge. We really don't do bleeding edges like we used to.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
We're past hump week, if such a thing were actually possible in this challenge[^], and we're starting to see the applications come to life. Overall the contestants' apps are coming together and they guys are focusing more on showcasing the Ultrabook and Windows 8 API than merely grinding out the framework code for their application. The contest has gone from "how am I going to get this done" to "how can I make it rock their socks?", and has expanded to more philosophical and design discussions on the nature of the Ultrabook and what it means for user interaction.
Lee is powering ahead. As a reminder he is working on an application that combines social messaging with random pot-luck. His OpenGL-to-DirectX 11 translation engine is working. He has NFC happening (after a little device foreplay - really, too much information) as well as a bunch of other Ultrabook specific support that is truly keeping with the spirit of showing off the Ultrabook hardware and Windows 8 API. Check out his videos if you like a little time-lapse craziness.
George and Suresh at Blue innovations look like they're close to being done with their MoneyBags 2.0. They are, methodically, working through their list of Ultrabook features they wish to support (I think it''s all of them, at last check) and have gone as far as to provide an eBook detailing their progress and their earned wisdom. Grab yourself a copy of A Simple Guide to Ultrabook Development. An important UI issue these lads have discussed is ease of use of the touchscreen. Grab a tablet or iPad and think about how easy it is to reach various parts of the screen. On a 3.5" screen it's all accessible. On a 7" the centre bits take a little wiggling. On a 13" touchscreen laptop there are definitely parts of a screen that are easier to hit than others and an application's design should take this into account. Their use of hidden menus, though, would draw a serious, horizontal-brow'd frown from Jakob Nielson. Don't make your application an adventure game. It should all be obvious.
Shailesh has discussed something none of the others have: Windows 8 app certification requirements. Sure, a little boring, but kinda critical. They made huge progress on this front, raising their app's overall assessment from "Critical issues found" to "undefined". No news is good news.
John and Gavin are also in a great personal space. They are feature complete. Complete with bugs and with optimisations to be done, but complete. They mirror comments made by others that hover is dead. Anyone who's written an app or a website optimised for touch knows that you don't have a mouse or cursor. Unless you insist on stylus based devices, you crazy cat, you. Touchscreens may, in future, have the ability to detect your finger from a centimetre away and provide hover events, but for the moment it's binary: you're touching or you're not.
Sagar loves a little drama and did what any red blooded developer would do when given a pre-release piece of hardware running a pre-release OS with pre-release drivers: he tried upgrading to RTM bits. You can picture how that went. Regardless, their Shufflr video sampler application is fully bean-bag enabled using the inclination and accelerometers. Quick tilt-and-back to flip to the next video. Tilt-and-hold to scan through a video. Very nice.
Andrea is continuing to work on his language trainer. It's coming along, but as I've said in previous posts: I'd like to see something that more fully showcases the Ultrabook. At the very least a discussion on the ins-and-outs of developing touch screen UIs for web applications would be valuable.
Overall, we're close. The Intel Developer Forum is next week so contestants will have a week off to booze, I mean, discuss strategy with peers in informal round-tables, so there will be a break in the regular scheduling.
Initially I thought my vote for the top app was sewn up early. However, as we see how the contestant think, and how they approach the application development process, I'm now torn in 3 different directions. Pushing the boundary hard and far always gets point from me, but sitting down and methodically working through the issues to produce an app that makes sense, rather than on;y being a showcase, shows a deeper commitment to me.
We only have two more weeks for each to finalise their offerings. This will be interesting.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
The Ultimate Coder challenge continues and it looks like the contestants are getting down and dirty. To add to the spice I now have in my hot little hands a prototype next-gen Ultrabook loaded with Windows 8 with which to test actual applications. The unit is a pre-production test unit, so it will never actually be on the market, nor is it meant to be a perfectly polished example of the genre. The fact that they provided the sort of power cable you'd find on power tools, and the lid is rubberised so that (a) you can get a good grip on the thing, and (b) it probably bounces when dropped, speaks volumes about the kind of torture to which they are expecting it to be subject. It makes me want to look at them with big, wide, innocent eyes and reassure them that I won't break it. I promise.
I am deliberately not investigating the new Ultrabook features on the demo unit. In fact I'm deliberately not even trying to find out which features it has because I want the contestants, through their apps, to teach me. I want to discover the features, and I want to be amazed. I am, however, re-familiarising myself with windows 8 and The Design Formerly Known As Metro (DFNAM) UI. I'll say outright I'm not a fan of the schizophrenic Desktop/The DFNAM UI split personality.
As a reminder: central to this quest is requirement that contestants "create apps that take full advantage of the performance advances, graphic excellence, touch and sensor technologies of the latest Ultrabook™ computers". This is a competition and while an awesome application that blows me away gets points, only an application that takes full advantage of the unique abilities of an Ultrabook running Windows 8 will win. Showcase the platform, not your application, and prepare to get out of your comfort zone.
As has been a theme, Lee is tromping through with steel shod boots where angels fear to tread. The man is crazy, and I dig that about him. If you are looking to develop Windows 8 applications, follow Lee's blog. He's starting from basics - commenting out windows.h, building (and failing to have success with) static libraries, multi-core development, sensors, DirectX 11 and everything that comes with that.
George and Suresh are continuing with their MoneyBag rewrite. They have progressed to the point where a preview is available, but the download requires registration and no registration email made its way to my inbox. So, as much as I'd love to comment on what they've done hands on, I can't. However, they have continued to provide extensive details on how they are progressing and the challenges they are facing, and have provided a checklist of Ultrabook features they are targeting. Not all Ultrabook features centre around sensors and jet-packs. These guys are focusing on the subtler things such as instant on, touchscreens and Smart Connect.
Shailesh has hit a roadblock. They want to use SQLite, they have read it works with Windows 8, they have the JavaScript library...but it's busted. They have retreated, licked their wounds, and have gone with the recommended approach of using Local Storage. Time will tell.
John at Soma games are discussing what they are using more than how they are supporting Ultrabooks. In particular they posted that they will be using the Unity 3D 4.0 engine - which is an interesting gamble since it hasn't been released yet. While it's great that the Unity 3D 4.0 engine will support the DFNAM UI, I would like to have heard more on how this ties in with their application really showcasing the Ultrabook experience. They demoed touchscreen, DFNAM support means it plays nice with Windows 8, and Unity 3D should push the GPU hard, but I'm hoping there will be some other sensor or power management or notification based component of the game that makes you think "this is a great game on a PC, but it's killer on a Ultrabook".
Sagar have hit another seemingly unnecessary roadblock: ambient light sensor support need the DFNAM. They are also having NFC sensor issues on their Ultrabook, which just continues their run of bad luck. Part of the challenge in this competition is that it's being run on pre-production hardware and so driver support may be immature. I know I ran into a wall trying to get a new touchpad driver, so I'm hoping their contacts at Microsoft and Intel will come through with the goods. At least the accelerometer is working for them.
Andreas is plugging away at his language training app. Since he's chosen to use HTML, issues with building libraries, using native code, and all the fun with sensors is a non-issue. Although, that's a double-edged sword since it limits his ability to really show off what an ultrabook can do.
We'll see what everyone has up there sleeve next week.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
The Ultimate Code Challenge[^] continues into its second week. 6 developers, 6 svelte 3rd generation Ultrabooks, 6 apps that will wow and amaze us. In 6 weeks.
Most of you are thinking "and if it were my boss, he'd demand I do it in 3, and the specs would change on day 20". When I was a lad...
Lee[^] continues to work on Love Hearts, a social app for sugar addicts that utilises the Always On Notifications system to send alerts to your co-addicts and have their machine, which they thought was safely asleep, respond to your message by 'pinging' you. At 2am, presumably. Are they talking a polite "pip", or an actual 140dB full sonar ping. I'm sure there's a setting for it somewhere.
At the core, Lee is looking to create an app that showcases the abilities of the Ultrabook and the Windows 8 OS. Pick up the Ultrabook and the game responds. The app is playable using only the touchscreen, and his fundamental philosophy is that the game should be discoverable in an enjoyable way.
I am a little worried, but also grinning a big grin, when he discusses a major issue with Windows 8: a metro style app cannot use OpenGL. So he's going to write his own OpenGL library in DirectX 11. That's so awesome.
George and Suresh[^] continue to discuss MoneyBag, an expense tracking application based on (but a complete rewrite of) their 1.0 version of the same name. The standard challenges of screen resolution and touch vs mouse are discussed, as well as the use of power saving APIs in Windows 8.
I'll be honest with this one: I want to see more use of Ultrabook specific features. I hear rumours of an NFC chip on the units, and what better way to drive adoption of a financial planning application than by offering your users the means to bankrupt themselves by whipping out their Ultrabook from their jeans pocket, tapping it at their local supermarket, and spending themselves broke in a frenzy of Ultrabook NFC tapping madness. I'd do it, simply for the looks on the cashier's face. And then, obviously, I'd need to do some serious self-reflection, probably with the aid of a financial management app, and work out where all the money went.
Shailesh[^] continues to work on his BioIO teaching app. Again, the theme of variable screen resolutions and touch enabled interfaces came up, which is not enough of a differentiator among this group of contestants. I'm hoping they have a killer feature that showcases the Ultrabooks up their sleeves. One niggling comment is that as a dev I read code better than prose, so their screen shots of code at an equivalent of 3px font is a little painful to read. Guys - any chance of posting code as, well, code, instead of images?
Soma games[^] are writing Wind Up football. While I was hoping for a fully immersive experience involving the use of the gyro, accelerometer and touch screen capabilities, combined with your boot and a run-up kick, it turns out they had something far more prosaic, and potentially more sustainable in mind: a touch-screen football game. And it looks awesome. These guys are developing an iPad version in parallel, so have a headstart in terms of game design, graphics and audio, but are already identifying challenges such as variable screen resolution, and, well, a keyboard.
Sagar[^] have entered the second week and hit a brick wall. Metro apps can't use WiDi to stream Metro live tiles to a TV. This is crazy, and invites the inevitable comparison with iOS and AirPlay. They have also hit hurdles trying out the sample code for Ultrabook sensors, and have generously provided info on how to fix them. 5 weeks to go and they've done a reset. This is a pity, but the bigger pity seems to be the Metro/Desktop dichotomy. We all understand that Metro is for phones, tablets, and touch-enabled Ultrabooks, and Desktop for those times you need a desktop, but splitting support for hardware between WinRT and native will make no sense to users. Why would you have NFC support in Desktop apps but not Metro apps? Are you more likely to tap your desktop or your phone at a checkout?
Andreas[^] seems also to have stepped into the minefield that are the Microsoft samples. Once he had the exceptions under control, he found a neat little issue: push notifications will throw an exception if you have no internet connection. Obvious, really, and I understand that samples are merely snippets to get you started, but no exception handling? Guys... In any case, Andreas is on his way.
A se two common themes from the contestants. The first is that the UI for their apps should be easily discoverable. Time and effort is being spent ensuring that the actions you need to take to achieve outcome are obvious. This, to me, signals a serious maturity in Windows application development. Engineers are realising that users don't appreciate their technical excellence: they appreciate an app so easy to use that they forget they are using an app. Hallelujah.
The second is that the samples for Win8 sensor support is a mess, the support for sensors is uneven, and that the library support between Metro and Desktop apps is not consistent. This is a challenge. An unnecessary challenge, in my opinion. It does, however, make my life as a judge far easier because the harder the challenge the more the field is split.
A small disclaimer: in this post I use the term "Metro" to refer to the name of the Design Language Formerly Known As Metro simply because that's what the contestants are using. It has another name that I keep forgetting, so for now, when you see the now-defunct term "Metro", simply replace it with "The Design Language Formerly Known As Metro" and all will become clear.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
Posted in response to How to Write Code Comments Well[^]
There have been many arguments on whether code should be commented. Here's my experience.
Comments fall into two buckets: Object and method decorations - those that explain what a file, object or class does - and in-code explanatory comments that appear inside methods or blocks of code to add explanations, notes, or to explain the non-intuitive.
Anyone who says that there is no place for comments inside methods is, to me, misguided at best. Code is not a literary work of fiction open to various interpretations. It's a precise series of instructions, and sparing, sensible, well-placed notes on what's going on inside a method can prevent disasters.
There are many, many, many developers and proscribers of dogma that insist that decorative comments are also unnecessary. The standard argument is that names should be clear, descriptive, unambiguous, and as long as necessary.
If we all spoke the same language, had the same cultural background, same experiences, same literary ability, and all wrote code at exactly the same time, using the same, precise naming conventions, then yes, good naming will solve most ills and decorative comments are not that essential.
However, we don't work in this environment and it's extremely short sited, and costly in the long run, to think we do.
A term used in one context may mean something different in another. A trivial example is "Create" which could mean create a new object in memory, or store an existing object in a row in a database.
A term used in one culture may mean something different or, in fact, the opposite in another. To "table" something in North America means "to postpone for consideration". In the UK, Australia and the rest of the English speaking world "to table" means to begin consideration of the topic.
While it's straightforward to use names that are more descriptive it's important to understand that ambiguity is often difficult for a single developer to spot. They know what they mean, but it's only after other developers look at their code that it becomes apparent that other developers may not. Do not fall into the trap of assuming everyone understands what you mean.
One solution is to mandate that names be fully descriptive: CacheObject, UploadToCloudStorage, DiscussIssue. This helps a little, but very soon you hit the point where providing an unambiguous descriptive name stretches the limits of acceptable name lengths. Steve McConnell writes that method names should be between 9 and 15 characters. Good luck.
Still, this doesn't help. No matter how well you name something, how consistent you try to be, how dire your threats are to other devs, you'll always have situations where you just don't know, with absolute certainty, what a method does. With no comments the developer needs to go and read the method to understand what's happening. This is a monumental waste of time, and worse: it's frought with peril when code is read but the intent not understood.
Another issue is parameters. While the same arguments for tight and descriptive method names should be applied to parameters, it's almost impossible to encode in a parameter name things such as restrictions on acceptable input values or notes on special value handling. Comments on parameters allow you to understand the results of suppling null, 0 or empty values, and to understand the limits of what you can supply.
My approach is you should be very, very careful with object and method names, and strive to be descriptive and unambiguous and have as your goal a 95% clarity on naming. That is, 95% of the time a developer reads a method name, that name is clear and unambiguous. However, the list of ambiguous names - that 5% - will vary per developer. That list of ambiguous names may even vary over time for yourself. A simple, clear, well-written, and up-to-date comment will solve this ambiguity.
The "up-to-date" specifier raises the issue of drift. The purpose of a given method may drift slightly from its original intent. The comment attached to that method may then be slightly (or seriously) out of sync with the intent. So too may the method name. To use the argument that comments are useless, and at worst, dangerous because they may not represent what the method does can, and should be applied to method naming as well. When a developer updates a method is it easier for them to make a note of any provisos in the method comment, or is it easier for them to rename the method, and hence the object's API? The method name and the comment should both be kept up to date. Developers get tired and cut corners though.
The way I approach software development is to assume the worst. I assume the inputs to my methods will be bogus. I assume methods will return null. I assume the database will explode in a searing ball of plasma when I run a query. I also assume that my wetware will also have issues and that, at one time or another there will be confusion.
The means that all methods and parameters are commented. This ads approximately a minute of development time to each method. It also adds a small amount of time each time a method is changed to scan the comment and ensure it's consistent. It also means we have a ton of comments that, 95% of the time, add no value. However, since the set of methods that raise ambiguity or clarification issues is non-fixed, it's not practical to simply comment 5% of the code.
While it's tempting to say "just comment the methods that need it", this leads to a slippery slope that we've seen in practice again and again. The test of "what needs it" is carried out by the coder, who almost by definition finds their code clear and unambiguous. One by one "obvious" methods are created without comments and soon we have devs interupting their work and that of the author to discuss what's happening.
The application of under a minute of effort saves 5 minutes of conversation and the inherent costs involved in task switching productive developers.
Comments aren't things that hang around code like bad groupies. They are code, and when the code is updated, so too must the comment.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
The Intel Ultimate Code: Ultrabook challenge[^] is an interesting experiment. On the surface it’s a coding challenge: Six developers compete for six weeks to create apps that take full advantage of the performance advances, graphic excellence, touch and sensor technologies of the latest Ultrabook computers. Scratch a little deeper and you realise that this is a 1 part coding and 5 parts hair-tearing game of strategy combined with your worst mid-term practical, ever.
Six Developers (well, eight actually - you can see the rules are already being tested at this early stage) get 6 weeks to develop the ultimate app for the Ultrabook that makes use of Windows 8, touchscreen capabilities, sensors such as gyroscope, GPS and NFC (to name a few), and the raw power of a 3rd gen Ivy Bridge i7 CPU.
For the next 6 weeks I'll be posting updates on the progress of the challengers. These are seasoned developers. They have been around the block and have a full shed of tools and tricks at their disposal. They are not to be trifled with. I am expecting, and maybe hoping, the veneer of gentile competitiveness to fall away quickly and settle down to a nice exciting game of psych.
Lee[^], for example already has an app-in-a-box application that will enable him to write his apps in Basic and target 7 different platforms. He’s using Basic. To write the ultimate app on the ultimate notebook in front of millions of developers. You can see the sorts of mind games that have already started.
George and Suresh[^] have reportedly tried out over 30 designs concepts and more than 200 assets to arrive at their final design. In less than 3 days. They also already have mockups of their final app and will be building on an existing app. In this day and age merely changing the font is enough to warrant a major release, so I’m going to be watching these guys closely. And it should be noted that any use of Comic Sans in an application leads to immediate disqualification.
Shailesh[^] from clemsoftware will be creating an Ultrabook tuned version of their BioIQ picture puzzle game. Basically: label the parts of the organisms and you win. I’m guessing touch will be a large part of the ultrabookification of this app, but what I’d really like to see is something far more immersive such as a modern day version of the children's “Doctor” game. Either through touch, or by tilting and moving the entire ultrabook you control a surgeon's knife and perform something simple like a coronary bypass. I breezed over the specs of the ultrabooks sent to the devs, but I’m sure there’s something that would add a little je ne sais quoi to it all. An electrified touchpad or the NFC chip wiping your credit cards in a “simulated” malpractice suit would add a little spice, no?
John[^] and Gavin from Soma games (I think this makes it 8+ devs, right?) are creating an app called wind up football that takes advantage of the touchscreen and accelerometer. I will be satisfied with nothing less than an app that requires you to actually kick the Ultrabook in the same way virtual golf courses have you hit a golf ball into a sheet. The touch screen can measure the location and, potentially, vector of your foot, the accelerometer can then calculate the projected path, and the gyroscope would be used to measure rotation. Their challenge will be accurately simulating the aerodynamics of a flying, spinning Ultrabook, but I assume that’s why they also mentioned the new CPUs as being integral to their app. Nice one, boys. I’m definitely looking forward to this one.
Sagar[^] and his crew made much mention of the trials of actually getting their hands on their Ultrabook, which is actually a step further than us judges have managed to get because we’re evidently embargoed from getting our greasy, cynical paws on the shiny new ‘books until the challengers have completed their penultimate post. Sagar did mention in passing that the judges pics were way cooler than the challenger’s pics so he gets 2 points this week. However, I do need to subtract 2 points for dropping the “e” in his product’s name. Ever since auto-correct was invented spelling has gone to hell in a hand-bascet.
Andreas[^], the final contestant, is retrofitting his HTML5 application to use touch capabilities for his vocabulary trainer app. Having drifted from my base of C++ and MFC over to the dark, yet surprisingly comfortable side of Web Development I find a certain kinship with this contestant. By writing in HTML5 and Javascript he is, however, opening himself up to the inexorable curiosity of web developers worldwide. Of course I’ll poke around and check out his CSS and Javascript, and of course I’m going to fire it up in IE5 on my old Mac and complain vociferously that it doesn’t work properly. However, if he puts in the Konami code then all will be forgiven.
Let the battle begin.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
Not only mind games, but I kicked a few of them in the leg before we started 
|
|
|
|
|
the less I know the better.
You've got my address for the cheque, right?
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
Thanks for giving us your insights and your views. Thank-God we are not using Comic Sans Font 
|
|
|
|
|
We have a new article submission wizard!
The short version is we have a new article submission wizard (and updated systems) that provides
- An all new, single page article editor.
- An auto-save facility in case of crashes
- The ability for members to edit "edited" articles safely. No more needing to send in updates manually.
- Simplified references to uploaded files.
- A new "Alternative article" option that allows you to create alternate versions of existing articles
- An update for Tips n' Tricks so that they now use the standard article UI
- You can now upload images and downloads for blog and tip articles.
- The ability to easily switch article types (Make an article a tip, promote a technical blog to full article, etc)
The longer version:
About 6 months ago we finally had the time to revamp the aging submission wizard. I wanted a single page editor that allowed in-page (ie Ajax) file and that looked very much like what the final article would look like. The idea is that it would feel like you were editing the article in-place. Click on the title to edit it, upload a file and add the file to the content with a single click etc. And, of course, auto-save with a simple recovery model for those bad times.
I also wanted to address the need to allow our authors more access to their articles. Currently what we do is we pick the top articles and edit them. This editing corrects formatting, spelling, cleans the downloads and generally ensures that the article conforms to our standards. However, once an article is edited by an editor it is inviolate: it can no longer be updated online by the original author.
The reason for this is that, after spending so much time fixing articles, we were getting a little frustrated when members would go an re-edit the article's we edited and re-introduce all the errors we had fixed. This is understandable because they would often simply take the copy of article they had originally written, make corrections to it, then copy and paste it over whatever we had done. So we put an ednd to that for our own sanity and made a pact with ourselves (and with you) that we would be as fast as possible in posting updates you sent in.
However, this punishes those who are good authors for the sake of protecting the few that are bad, so we've come up with a compromise, and also a solution to a subtle problem.
Previously when you posted an article using the wizard, the article would be placed in a Pending queue and would be reviewed by other members who would then approve, disapprove, and/or comment on the article. After approval the article became public and everyone was happy. Except that the author could now edit their new article, upload a bunch of inappropriate material, and have it available immediately. The solution was to modify our system so that all edits of articles create a new pending version of the article. After editing, the old version will still be seen by most members, but moderators will be able to see (and approve) the new version. Once approved the new version replaces the old version and goes live.
In doing this we had to tackle a few issues with files. We choose not to store files as database BLOBs, but as system files, so where do we store your upload files while you're editing? When you start the submission wizard you haven't chosen a section, yet you can upload files. When editing an existing article you may need to upload new versions of files (updated zips or images) but we need to ensure the old version of those files and images are still available for the current article.
We ended up introducing a "Working" directory for your new uploads in order to separate out the old and the new, but this then made life difficult for those looking to reference files in their article's HTML. Previously we had the concept of a "Basename" for an article, which was effectively the name of the article's directory, and which author's used to reference an uploaded file (eg src="basename/myfile.zip"). We've abandoned that since it causes problems with name uniqueness, and in fact abandoned the whole concept of asking members to worry about directories. Now you simply reference an uploaded file by its filename, and we make sure we track things like which file (old or new) you're talking about, as well as ensuring we adjust the references in your articles during the various stages (composing to pending to available).
We've also introduced the concept of Alterative Articles. There are many, many articles that are no longer being maintained and this is a first step to allow other members to take over abandoned articles, or to simply provide different implementations such as a different language.
To provide a symmetric article experience we've now upgraded the Tips n Tricks articles to be displayed in the same manner as traditional articles (as well as their alternatives), and now make it very simple to convert a tip to a standard article, or to any other article type. No more complaint about short articles or long tips. We can quickly recategorise as needed.
This also brings a nice benefit: you can now upload images and zips to your blog and tips articles.
With regards to moving tips to the new UI - you might notice something a little weird with your rep. We moved all the comments that were associated with tips into their own separate forum for each tip instead of having the confusing comments-per-tip-plus-bonus-forum-at-the-bottom.
This release should be conidered a Beta release, so please send in all feedback and bug reports to the Bugs and Suggestions forum.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
Good work Chris!
Chris Maunder wrote: In doing this we had to tackle a few issues with files.
Are all the quirks with that worked out now? I found something weird,. I have a pending update, but I am hesitant to let it go through as all the pictures are gone from "preview" page.
Is the preview not working with the pictures or will my "article get broken" if I go through with my changes?
|
|
|
|
|
As far as we know the kinks are gone, but we have seen a couple of issues from bugs in our old system that only manifested once we moved to the new system. It's amazing how these bugs hibernate - like cicadas.
What is the URL of the article? I'll take a look and sort out whatever the issue is.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
|
I fixed up the links and it's all good now, though I think I may have inadvertently published a version of your article you were still working on. If you wish to rollback, go to the Revisions tab on your article, choose the version you wish to revert back to, and hit revert.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
All good, that is what I tried to do.
I see tha TOC links broke (or where broken already?). I can fix them later.
Thank you for the help.
|
|
|
|
|
Hi Chris.
I had to roll back a few versions and put in my changes again. What is needed for me to make the new version "active"? Right now it says "pending"?
- Kjell
|
|
|
|
|
High level members are constantly reviewing the Pending list. Once 5 of them approve it it's live. This is usually a quick process.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
Hello,
When I try to publish my article, I see this error: "The content is either too short or default."
I don't know why? and What can I do to publish the article.
It's not a short article.
Do not criticise, if you don't have any better idea.
|
|
|
|
|
Thanks for the great change Chris!
Is it possible to roll back a change after updating? I mean just in case we find out something went wrong after updating an existing article (due to maybe a bug or malfunctioning).
|
|
|
|
|
Meysam Mahfouzi wrote: Is it possible to roll back a change after updating
Absolutely. Hit the Revisions tab, choose the version you wish to use, and hit the Revert button.
cheers,
Chris Maunder
The Code Project | Co-founder
Microsoft C++ MVP
|
|
|
|
|
Cool I like the new wizard, will be making use of it really soon
Sacha Barber
- Microsoft Visual C# MVP 2008-2012
- Codeproject MVP 2008-2011
Open Source ProjectsCinch SL/WPF MVVM
Your best friend is you.
I'm my best friend too. We share the same views, and hardly ever argue
My Blog : sachabarber.net
|
|
|
|
|
Thanks Chris. Is there any possibility to upload the article from a HTML file?
Cheers,
Jani Giannoudis
Meerazo.com - Resource Sharing Made Easy | Co-founder
|
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
