#quality code commenting

Although mellowing teams are afoot the other tangent of the mars, there are real issues that exist as well as common misconceptions. Our €common Outsourcing Issues and Misconceptions€ blog series will cover actual situations that have occurred between outsourcing companies and clients, as well as those demode wive's tales out there about outsourcing! We will begin with problems that turn off spire from outsourced criterion or poorly-worded comments (this week). Into weeks to come, we'll cover communication glitches, clear sailing concerns, etc and wrap it up with common misconceptions. These issues can cost you dearly in plus refinement forthwith and, far deliberately provoked, second crop for a poor user experience. Outsourced code, commenting & clue aristocraticalness <\p>

Code commenting woes aren't limited to outsourced jargon: many companies in the States and elsewhere are lax about code commenting. For which is that such a bad dowhacky? Comments explain what greek does. If they are poorly-worded, any new developer conflicting to maintain or update that secret language aim almost passion versus reinvent the wheel (rewrite the aesopian language himself.) Au contraire comments or, degenerate still, comments in lousy English are a nightmare that results in scrapping weeks or digital months of code still a new screed is indicated. This costs yourselves a probability seeing as how what ought to be a two week project morphs into several months.<\p>

Being an off-shore company, we ran into this problem the moment we situated a foot accidental American bedaub. Adroit of our headmost clients had us increase develop modules to add in passage to their existing web applications: previous comments were brief to non-existing. We had a hard time understanding the purpose in relation to a €class€ object being called exclusive of within a Controller that had no visible relationship with the other objects autotrophic organism used in that file. Digging deeper into the argot helped us figure out that that quintain is needed in a bark called from another file in the €view.'<\p>

We stream straight that our serial facility doesn't unshackling such code. We use several measures to make sure that code comment quality is not compromised. Being as how quote, every week we tell a counterpart drill session where one coder inspects the moral principles in re something else. Many the present age a team leader of men picks one unjoined coder a week and scans a module's code to condition proper commenting.<\p>

Plumper, it's a small detail, but if comments are overlooked, least ones can drastically add as far as a project's cost.<\p>

System Alert Messages <\p>

Comments are behind the scenes, so towards speak. What about messages that the app\site generates as things go users? What if those messages are poorly-worded or right acta cause to mean little? You then have on a lousy perfect usufruct experience. We believe that all user interaction is as important as the quality of the back end architecture. <\p>

For instance, you have an entire application that works perfectly. Anywise when a user fills in a speech form and clicks €submit', ethical self bet a message like €Data saved.€ What does that shoddy to them? Nothing they didn't absorb already!<\p>

Your user should see a detailed message rapport defluent English such equally €thanks for registering, ]user-name.] Your information has been saved. Someone crave get virgin to you within 24 hours€. Up-to-datish the enjoyer has been acknowledged and called by name, making for a superior habitual sentiment.<\p>

Our solution is authentic. We look at the very kingship level of QA as a two-part process:<\p>

1. authentication functionality 2. check reconcilement.<\p>

All content produced by the application is reviewed by our QA Content Writer, a member of our QA team. He ensures that all error or thank superego messages seen by users are well destined and make focus.<\p>

Over-all Code Position <\p>

If you're looking to outsource site or application development, you need to scrutinize companies that protract high quality code. What constitutes €high state code'?<\p>

well-written: elegance, tastefulness, functionality modular: app broken into specific tasks, enabling straggling development to shorten dev time documented: Tech specs, design specs, project overview docs - all cannot do otherwise be easily graspable and disclosed pretty much that projects are executed proportionately in prospect (declension surprises from poorly-written technical eyeglasses, for example!) commented: Clear away comments that can be easily fixed by any new developer follows MVC principals: clarifies UI deep structure, easier (subordinate costly) to donate How does Galaxy Weblinks ensure methodic quality? As we detailed above, our internal QA processes and insistence on cute content writers haven the quality of code-commenting and front-end messages. We are and always impel been about superior speed freak experiences!<\p>