Rodel E. Dagumampan

Disputed Code Comments vs. Self Describing Self Documenting Code

dehran ph — Mon, 03 Sep 2007 00:15:00 GMT

Last week I have been reviewing some implemented features on our product, it works fine but not well written, got to have some refactoring specially my rule on comments.

Perhaps this is one the most disputed practices in software development, code comments. Personally, I seldom/don't comment my code. A well defined and structured code with self-describing and self documenting names and declarations is sufficient enough to make it understandable and maintainable at some point. Task aware lines such as TODO, HACK, REVISE tags works well but not all times unless it is integrated with the Issue Tracking tool or IDE. In some cases code comments is a residue of pseudo-code and I suggest it be removed from release code.

I have seen several cases where comments serve as documentation and explanation of a plain and simple methods. It often comes to a point that members of the team or API users are forced to read a bunch of comments first before understand the program flow. Even experienced developers tried to compensate their complex code, lacks of abstractness and intuitiveness, complex class' responsibility, and lacks of refactoring by explaining how code works on code comments.

Code comments also occupies a lot space on code view and added complexity if not well written. A comment that says "//initialize the treeview with list of products" on a method "InitializeProductTree(List<Product> productList)" doesn't make sense!

Consistency of the comment to the intent of the code it describes is not guaranteed. Developers that writes pseudo code first before implementing through methods will likely forget to update the comments if a logic in code change and thus code and comment becomes inconsistent and inaccurate.

Vanity. This is funny as I have seen some codes that serve as vanity and aesthetics to show style. It looks beautiful seeing those green lines. Taking a closer look and reading it, it tells me something. "I'm here, but you ain't gonna need me".

XML documentation is best placed in a separate xml file so the code base size will be reduced. A fully xml inline-documented class when not collapsed gives complex view and forces the API user read the comments first.

When to put comments anyway?

I don't think there's general rule when and when not to place comments. IMHO, its mainly common sense.

Intent. Comments describes the intent of the method or class. It should tell why the code was written, at what feature or requirement it serves.
Responsibility. Commends describes the responsibility of the code and its participation in the implementation feature or fullfillment of a requirement.

Guilty? Share your side.

We are hiring .NET Developers, Graphic Artists and Xhtml Experts - Davao City

dehran ph — Mon, 13 Aug 2007 18:14:00 GMT

We open positions to all aspiring/experienced developers and designers graduate, undergraduate, or was not able to pursue tertiary education, it doesn’t matter. We are looking for passionate people who are willing to learn, be trained and can get things done. People who value simplicity, code quality and take ownership of it. Who can work on a team and can get things done the right way.

We are a very young and small start-up team headquartered in Davao City, Philippines. Temporarily we will be working in a small box-type office, good for 6 people only, but will relocate once we found a better location. We offer above average salaries, flexible working hours, and very nice computers.

This seat might be yours.

Please send your applications and referrals to address: rdagumampan[xATx]gmail.com

* dual screen setup is a benefit if you performed well, also when function and UI testing.

Haven't read any .NET book in more than two months

dehran ph — Mon, 13 Aug 2007 17:43:00 GMT

In the past two months since I moved in a new direction of my career, I havent read any techincal books. I can remember the past three years, nagsusunog talaga ako ng kilay reading a lots of programming books, design patterns e-books, blogs and articles. I can read a thousand page book in one week, while reading another in the middle, practicing the samples at the same time.

Things changed, I realized while I still have the strong passion and keep my competence at high, I must also learn something new about reality of living and aiming the future in prosperity. Improve my outlook and attitude, staying optimistic and plan ahead.

Books I have read in the past two months:

7 Habits of Highly Effective People

Powerful Lessons in Personal Change

Author: Stephen Covey

You can make your life beatiful

Discover the simple path to happiness. Open this book and let your soul be drawn closer to God.

Author: Bo Sanchez

Simplify and Live the Good Life

Create wealth in every area of your life and be guided as you journey towards your personal expressions of simple happiness.

Author: Bo Sanchez

Rich Dad Poor Dad

What the Rich Teach Their Kids About Money--That the Poor and Middle Class Do Not!

Author: Robert Kiosaki

Books I have lend in the past two months

Code Complete 2

Strategic approach to software constructionand produce superior products

Author: Steve McConnel

What is Web Design

Design for the Web is the most significant new area of design practice of the last 20 years.

Author: Nico MacDonald

Finish the feature on time, you'll get your Resharper license

dehran ph — Mon, 13 Aug 2007 17:27:00 GMT

When I was asked by my partner why we need to install resharper, I just can't explain it all. I just said "there are more than 1000 reasons" for us to have it, then he asked how much is the license and decided we'll get it. If he asked again for specifics, I will give him a bad code and we will just compete to make it good LOL.

Listed are some of the shortcuts that is hard to live without. It's hard when you are peering with your teammates and you are the only one using it, Goto Definition lng, hirap pa gawin. Ctrl + F (Find) to the resque.

Ctrl + E
Ctrl + N
Ctrl + Shift + N
Alt + F7
Ctrl + F7
F12
Alt + Enter
Alt
F12, Shft + F12
Alt + Arrow Up, Alt + Arrow Down
Ctrl + Alt + M, Ctrl + Alt + V, Ctrl + Alt + D, Ctrl + Alt + P
Ctrl + Shift + Backspace
Ctrl + Alt + F
Live templates

But not so fast, I'll give my team a challenge. Each member will be given a feature to implement. In an agreed estimate, when the feature was finished, he will get the resharper license. If he missed it, it will still be given but just after two features implemented. Challenge will start on internal version 2 of our projects. Sound's cool?, refer your friends in davao we're still hiring :).

High cost of low quality code

dehran ph — Mon, 13 Aug 2007 17:22:00 GMT

A company Revsys blogs about the the high cost of low quality as a guide to hiring developers. See the full entry here.

I personally share the same view with hiring expert developers for start than building up a fresh-grad from the ground. For a company just starting up, quality is a must and you simply cannot compromise it.

So how can a average programmer be an expert developer? Read the followup entry here.Publish

Jason Jimenez (aka smash) joins FlexMerchant Software

dehran ph — Mon, 13 Aug 2007 17:20:00 GMT

I am breaking the silence here at devpinoy. Jason Jimenez a.k.a smash, the creator of ClassicReports, our fellow blogger here, and Davaoeño joins our development team. Jason will be part of our pioneer team. We are dynamic and fast, we're are moving. Now we are three! yahoo!!! :o).

Vista's Annoying Daily Dual Monitor Configuration and No-Extended Taskbar Support

dehran ph — Tue, 03 Jul 2007 02:46:00 GMT

While I have used dual monitor before with my laptop and a spare CRT screen, this is my first time to extensively use multiple monitors for development, testing and working with multiple tasks at the same time. I find this very helpful and definitely increase my productivity. However, it was really annoying that every day when I booted up my computer I have to configure again my Windows Vista Display Settings to identify my second LCD. There are times that I have spent 10-20 minutes just trying to make this work!

I was also disappointed that despite the existence of this feature in previous versions of Windows, still Vista is not capable of extending the taskbar to the other monitor. I believe this is very basic functionality that most dualmon users needed. I goggled around and seems Ultramon is a cool app.

Share your tips.

Usability: Build better software with naive testers

dehran ph — Sun, 24 Jun 2007 16:56:00 GMT

It's 1:00 AM in the morning. I have spent several hours trying to debug a major issue on the image synchronization service of our product. An issue so trivial I am clueless where to look-up into. Is it on the windows service deployed on web server, or on the windows forms CRM module, or on stored procedures and web server, or a file system issue. Is it because it is because Windows Vista. Is it because of improper settings and configuration? Configuration where? Why is it failing only on one computer? Its works on my machine!!!

After diagnostics and testing I have found the culprit. Its on the name of folder where the windows app retrieved the images. The application has 4 source folders for its images to be uploaded, "small, "medium", "large", "tuhmbnail". From those folders do you know where is the error?

Call to action:
Better error, debugging, and informational messages.
Better logging and event diagnostics.
Better checking and input validations.
Better settings and configuration management.
Better communication with testers and users.

Answer: The "tuhmbnail" must be "thumbnail". One of my user/tester is really a very very good tester. He' the kind of user that easily gets frustrated with computers. He's the kind of person that will destroy a computer if it does not work the way he wants it to be.

SqlServer: Return Random Records in T-Sql, the GUID way.

dehran ph — Wed, 20 Jun 2007 18:17:00 GMT

In one of the website I have developed, we feature random products displayed on a webpart. This can be done several ways either of the code behind or via t-sql but I think the simplest way to do it is via t-sql with the help of Guid columns.

Globally Unique Identifier or GUID is a randomly generated guaranteed unique string originally used to generate reference numbers and keys in softwares. In Sql Server, it can be generated using the NewId() function.

Given GUID is random, adding a GUID column to the original resultset and use it as the sort column surely yields a random result. Sample script below:

1 -->

2 IF EXISTS(SELECT 1 FROM sys.tables WHERE Name = 'Product')

3 DROP TABLE Product;

4 GO

6 --create the test product table

7 CREATE TABLE Product (

8 IdProduct int PRIMARY KEY IDENTITY(1001,1),

9 ProductName nvarchar(255),

10 Price decimal(18,2),

11 AverageRating int,

12 ItemViewed int,

13 ItemSold int,

14 SortOrder int,

15 DateCreated smalldatetime,

16 LastUpdated smalldatetime)

17 GO

19 --initialize table with test data

20 INSERT INTO Product VALUES('Item 1', 10.00, 1, 99, 23, 1000, GETDATE(), GETDATE());

21 INSERT INTO Product VALUES('Item 2', 21.00, 2, 97, 56, 1002, GETDATE(), GETDATE());

22 INSERT INTO Product VALUES('Item 3', 11.00, 3, 95, 23, 1001, GETDATE(), GETDATE());

23 INSERT INTO Product VALUES('Item 4', 22.00, 4, 93, 65, 1000, GETDATE(), GETDATE());

24 INSERT INTO Product VALUES('Item 5', 12.00, 5, 91, 54, 1000, GETDATE(), GETDATE());

25 INSERT INTO Product VALUES('Item 6', 23.00, 6, 89, 12, 1006, GETDATE(), GETDATE());

26 INSERT INTO Product VALUES('Item 7', 13.00, 8, 87, 89, 1050, GETDATE(), GETDATE());

27 INSERT INTO Product VALUES('Item 8', 24.00, 9, 85, 21, 1021, GETDATE(), GETDATE());

28 INSERT INTO Product VALUES('Item 9', 14.00, 1, 98, 67, 1020, GETDATE(), GETDATE());

29 INSERT INTO Product VALUES('Item 10', 25.00, 3, 99, 78, 1001, GETDATE(), GETDATE());

32 --create the stored procedures

33 IF EXISTS ( SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[usp_query_all_featured_product]') and type IN (N'P', N'PC'))

34 DROP PROCEDURE [dbo].[usp_query_all_featured_product];

35 GO

37 /*------------------------------------------------------------------------------

38 // <procedureInformation>

39 // procedureName : [dbo].[usp_query_all_featured_product]

40 // description : get random products from a table

41 // createdBy : rdagumampan

42 // createdWhen : 06-20-2007 02:08 AM

43 //

44 // modification history

45 // date Modified remarks

46 // <procedureInformation>

47 */------------------------------------------------------------------------------

49 CREATE PROC [dbo].[usp_query_all_featured_product]

50 @pageIndex [int] = 1, -- current page

51 @pageSize [int] = 999, -- number of rows per page

52 @totalRows [int] OUTPUT -- total number of rows

53 AS

54 BEGIN

56 ----xx begin unit testing paramters

57 -- DECLARE @returnTop int;

58 -- SELECT @returnTop = 5;

59 ----xx end unit testing parameters

60 --perform attempt to retrieve all records

61 WITH result AS (

62 SELECT

63 ROW_NUMBER() OVER (ORDER BY NewId() ASC) AS RowNumber,

64 prod.IdProduct,

65 prod.ProductName,

66 prod.Price,

67 prod.AverageRating,

68 prod.ItemViewed,

69 prod.ItemSold,

70 prod.SortOrder,

71 prod.DateCreated,

72 prod.LastUpdated

73 FROM Product prod )

74 SELECT

75 prod.IdProduct,

76 prod.ProductName,

77 prod.Price,

78 prod.AverageRating,

79 prod.ItemViewed,

80 prod.ItemSold,

81 prod.SortOrder,

82 prod.DateCreated,

83 prod.LastUpdated

84 FROM result prod

85 WHERE prod.RowNumber BETWEEN

86 (@pageIndex - 1) * @pageSize + 1 AND @pageIndex * @pageSize

88 SELECT @totalRows = COUNT(IdProduct) FROM Product;

89 END

91 GO

93 --execute stored product for testing

94 DECLARE @totalRows INT;

95 EXEC [usp_query_all_featured_product] @pageIndex = 1, @pageSize = 5, @totalRows = @totalRows ;

DISCLAIMER: Use this script at your own risk. Never execute this script on a production database.

.NET: Updated: Simple and Stupid BackgroundWorker Example

dehran ph — Wed, 20 Jun 2007 17:36:00 GMT

I was very busy the past weeks, I cannot imagine I could make it not to code for several days, been a carpenter, janitor, messenger and everything hehe. But I'm here again now. Let me start this out with this stupid sample I just given to one of my junior developer.

BackgroundWorker is a special class in .NET 2.0 to help developers implement non-freezing UI, multi-threaded windows forms applications. It provides intuitive model for hanldling events, reporting progress, and notifying the user interface.

In my opinion, it is a must for all windows forms developers to know this and learn how to implement this. But the problem I can see is that, most of times junior developers dont know where to start and sometimes overwelemed by the documentations most websites and microsft provided. Lets keep it this simple :).

Instructions:

Create a new VS2005 C# Window Forms project.
Add a new Form, name it "WinAppMain".
On form add two buttons "btnStart" and "btnStop".
Add a label "lblStatus".
Add a progressbar control "progressBar".

Then review and implement this code, sorry but you cannot copy this hehe.

2 Description: very simple background worker sample

6 using System;

7 using System.Collections.Generic;

8 using System.ComponentModel;

9 using System.Threading;

10 using System.Windows.Forms;

12 namespace WindowAppEx {

13 public partial class WinAppMain : Form {

14 //class level variables

15 List<string> employees = new List<string>();

16 private BackgroundWorker worker = null;

18 public WinAppMain() {

19 InitializeComponent();

20 }

22 private void btnStart_Click(object sender, EventArgs e) {

23 btnStart.Enabled = false;

24 btnStop.Enabled = true;

26 InitializeList();

27 InitializeBar();

28 RunWorker();

29 }

31 //initilaize progress nar

32 private void InitializeBar() {

33 progressBar.Maximum = 100;

34 progressBar.Minimum = 0;

35 progressBar.Value = 0;

36 }

38 //create a dummy list, assume this is a list of employees to be processed on a backgroun thread

39 private void InitializeList() {

40 employees.Add("Marilyn Manalo");

41 employees.Add("Shereen Guinucud");

42 employees.Add("Eunice Hosmillo");

43 employees.Add("Haizel Lin");

44 employees.Add("Rizchelle Priagula");

45 employees.Add("Cyd Clarence Petalino");

46 employees.Add("June Aileen Fesariton");

47 employees.Add("Gwendale Gertrude Aranas ");

48 employees.Add("Juvy Viñas");

49 }

51 //create a new backround worker

52 private void RunWorker() {

53 worker = new BackgroundWorker();

54 worker.WorkerReportsProgress = true;

55 worker.WorkerSupportsCancellation = true;

57 worker.DoWork += new DoWorkEventHandler(worker_DoWork);

58 worker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(worker_RunWorkerCompleted);

59 worker.ProgressChanged += new ProgressChangedEventHandler(worker_ProgressChanged);

60 worker.RunWorkerAsync(employees);

61 }

63 //begin working on files

64 private void worker_DoWork(object sender, DoWorkEventArgs e) {

65 BackgroundWorker senderWorker = sender as BackgroundWorker;

66 List<string> inputList = e.Argument as List<string>;

68 for (int index = 0; index<= inputList.Count-1; index++) {

69 //do more work here

70 Thread.Sleep(1000);

72 int progressInPercent = (int)(((decimal)(index + 1)/(decimal)inputList.Count) * 100);

73 worker.ReportProgress(progressInPercent, inputList[index]);

75 //handle cancellation of the thread, even CancelAsync was called, the worker is still processing request

76 //explict hanlding of cancellation is needed here to avoud null reference exception

77 if(senderWorker.CancellationPending) {

78 e.Cancel = true;

79 break;

80 }

81 }

82 }

84 //executed when worker was finished

85 private void worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e) {

86 lblStatus.Text = "work finished processing request.";

87 }

89 //executed when worker finished processign one item

90 private void worker_ProgressChanged(object sender, ProgressChangedEventArgs e) {

91 progressBar.Value = e.ProgressPercentage;

92 lblStatus.Text = "working on file of: " + e.UserState;

93 }

95 //worker cancelled when cancel button was clicked

96 private void btnStop_Click(object sender, EventArgs e) {

97 worker.CancelAsync();

98 lblStatus.Text = "work was stopped.";

100 btnStart.Enabled = true;

101 btnStop.Enabled = false;

102 }

103 }

104 }

You can also create multiple background workers running at the same time. HTH.

.NET: A Significant Discovery On TortoiseSVN

dehran ph — Sat, 21 Apr 2007 11:17:00 GMT

I had very bad intermittent connection lately and this TortoiseSVN is really killing me. With my speaker system tuned on 60% volume playing jazz music to stimulate my mind, while I'm committing several files on our server, suddenly the SVN's error sound breaks my silence. This sound is really disgusting and I don't know why our beloved SVN community choose this. I would like to recommend that they used the windows error sound instead.

But anyway, I think I have to stop this. Googling around, I found that this can be turned off or change by Windows Control Panel!! Why didn't I know this thing exists... hay life, this truly makes me feel better.

MicroISV: In The Name Of Commerce

dehran ph — Wed, 11 Apr 2007 01:31:00 GMT

In the name of "commerce", I have to spend several hours today scouting the web for the best possible domain name for our firm that best represents our interests, services and products to be developed. With a lot of domain squatters on the web, its really hard to find one... Read More...

MicroISV: YetAnotherFirm LLC, Wtf is LLC

dehran ph — Sat, 07 Apr 2007 10:03:00 GMT

You might have heard this term as part of company title of most emerging IT companies who have delivery centers in the USA, Philippines and India. LLC stands for Limited Liability Company, where incorporators were given the security or assurance that restrict their legal liabilities right into the company itself only. It stands across the benefits of a corporation and partnership business structure... Read More...

Shift Happens

dehran ph — Tue, 03 Apr 2007 19:32:00 GMT

In the past 6 months I have been working as an independent developer spearheaded the design and coding of a shopping cart software for a Danish retail firm. But just last week, I was caught in the middle of two great opportunities where whatever I choose, I only have so little to loose. A UK firm invited me to join their pioneer team in the Philippines for their global service delivery center in Manila. A well-compensated position and a reputable company plus a good salary.

On my right hand is a business opportunity to be part of start-up IT firm while not compromising what I'm currently receiving as consultant of the firm. And develop the next generation "software for the poor" online retailers. I mentioned before that I am little hesitant to join consulting companies and I very much in favor on small R&D startups and ISVs.

It took me one week to evaluate these two offers and seeked advise from my parents, relatives, and friends. As result of a "unanimous votes" lols in favor of the latter, I decided to continue what I have started and accept the business opportunity at hand.

ASP.NET: Url-Rewriting In Migrated Website

dehran ph — Tue, 03 Apr 2007 18:13:00 GMT

Wow, it was January since my last post! sorry guys I'm was very busy coding, monitoring our house' dev't in province, preparing my relocation and some business matters. Anyway, a fellow filipino developer at msforums.ph raised the question if its true that URl-Rewriting "damage" page hits and page rank. Speaking from my experience here's my take.

Why do we need to implement ur-rewriting?
Well aside from aesthetic value, there quite a number of benefits implementing is. Read it drectly from SEO Expert's.

When Url-Rewriting Goes Wrong?
The problem I can see witn URL Re-writing is when you use this without care into a newly migrated or existing website which has considerable good page ranks. Implementing url rewriting can cause the search engine confused on which page to look for a particular keyword from your site. For instance, the original website you upgraded into ASP.NET has the page http://www.mystore.ph/products.php?product_id=1001 whch shows a Philips Flourescent Lights. This page maintains top rank in the search engine index. Apparently, you would like to migrate the site and implement url-rewriting into your product pages and convert the said page into http://www.mystore.ph/products/phiilips-flourescent-lamps.aspx. This is really cool and surely add your philips products in to the search index, but... you forgot to mark old page as non-existent and there's new page for the product. This is the problem! You now lost your position and the new site grows older and older.

A way to fix this problem is to issue a permanent redirection (aka. Error 301) when those old pages was requested. Why? When you upgraded your website and you removed those old pages, new pages will not appear in the search results right away, it will take some time before the cache gets refreshed. To test, you use http://siteexplorer.search.yahoo.com, you will see old pages are returned and not the new web pages are not yet indexed after the upgrade. When users searched or redirected into your new website' old pages, user will be lost and Error 404 will be issued whicn in turn puts your website in bad fate in page rank.

Since I implemented URL re-writing in one of our stores, it became #1 and maintain its position on www.google.dk search index. The engine is also doing good indexing our pages.

Reference:
Error 301 : Permanent Redirection Tutorial