CSC/ECE 517 Fall 2007/wiki2 9 kk: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


== Examples ==
== Examples ==
The simplest example in programming  where the name of a function does not indicate its functionality.
The simplest example is in programming  where the name of a function does not indicate its functionality.


<pre>
int add(int a, int b)
int add(int a, int b)
{
{
   return (a*a+b*b);
   return (a*a+b*b);
}
}
 
</pre>


The function above is supposed to add two numbers but actualy returns the sum of squares of the two numbers which would suprise the programmer who is using the function.
The function above is supposed to add two numbers but actualy returns the sum of squares of the two numbers which would suprise the programmer who is using the function.
Applying the principle of least astonishment, we can either rename the function to indicate its functionality or we can rewrite the functionality itself to correspond to its name.
Applying the principle of least astonishment, we can either rename the function to indicate its functionality or we can rewrite the functionality itself to correspond to its name.


<pre>
int sum_of_squares(int a, int b)
int sum_of_squares(int a, int b)
{
{
   return (a*a+b*b);
   return (a*a+b*b);
}
}
</pre>


 
<pre>
int add(int a, int b)
int add(int a, int b)
{
{
   return a+b
   return a+b
}
}
</pre>


== Application in Programming ==
User interface design:


== Application in Programming ==
The principle of least astonishment is primarily used in user interface design. [http://www.joelonsoftware.com/uibook/chapters/fog0000000057.html Joel Spolsky] has an article introducing user interface design using the principle of least astonishment.


== Applications in Other Fields ==
== Applications in Other Fields ==

Revision as of 17:05, 24 October 2007

Principle of Least Astonishment

The principle of least astonishment states that when you are presented with a different outcomes one should always pick the one of least ambiguity or suprise. The principle has applications in a lot of fields. This wiki serves as a guide for the reader to understand more about this principle.

Examples

The simplest example is in programming where the name of a function does not indicate its functionality.

int add(int a, int b)
{
   return (a*a+b*b);
}

The function above is supposed to add two numbers but actualy returns the sum of squares of the two numbers which would suprise the programmer who is using the function. Applying the principle of least astonishment, we can either rename the function to indicate its functionality or we can rewrite the functionality itself to correspond to its name.

int sum_of_squares(int a, int b)
{
   return (a*a+b*b);
}
int add(int a, int b)
{
   return a+b
}

Application in Programming

User interface design:

The principle of least astonishment is primarily used in user interface design. Joel Spolsky has an article introducing user interface design using the principle of least astonishment.

Applications in Other Fields

Bibliography