Jutustusi jõust – loetavast koodist

Koodist pulbitseb välja jõudu, kui see on loetav ja arusaadav. Seda vaadates ei hakka kõhus keerama. Jõud on tugev, kuid tasane ja vaikne. Rünnates seda jõudu, peegeldub kogu rünnak tagasi. Looda, et see ei ole jälestuse jõud.

Loe koodi kõva häälega nagu heeroldile kohane ning parem ära ole halva sõnumi tooja. Halva teate toojat ei austa keegi. Kui keel läheb sõlme ja suust välja tuleb ainult podin, siis parem põleta see ära ja meisterda see uuesti.

//Näide 1

public void DoSomethingUseful( )
{
	SqlConnection conn = new SqlConnection(connStr);
	string q = "SELECT * FROM users";
	SqlCommand comm = new SqlCommand(q, conn);
	try
	{
		SqlDataReader r = comm.ExecuteReader();
		while (r.Read())
			Console.WriteLine(r["username"]);
	}
	catch (SqlException ex)
	{
		Logger.Write(ex);
	}
	finally
	{
		conn.Close();
	}
}

public void RetrieveAllUsers( )
{
	using (var connection = new SqlConnection(connectionString))
	{
		var query = "SELECT * FROM users";
		var command = new SqlCommand(query, connection);

		try
		{
			connection.Open();
			using (var reader = command.ExecuteReader())
			{
				while (reader.Read())
				{
					Console.WriteLine(reader["username"]);
				}
			}
		}
		catch (SqlException exception)
		{
			Logger.Write(exception);
		}
	}
}

//Näide 2

Load += (sender, arguments) =>
			{
				if (!IsPostBack)
					Presenter.Initialize();
			};

Load += (x, y) => Should.Do(Presenter.Initialize).Unless(IsPostBack);

Eesti keel on ilus, kuid mitte lähtekoodis. Nii mõnigi õppejõud on soovinud saada koodi eesti keelsena, et vähendada lõika/kleebi tehnikat. Siiski on jäänud neil nägemisulatusest välja ümberstruktureerimise vahendid, mis lubavad hõlpsalt koodis nimesid ümber muuta. See nõue ei aita sel puhul ja risustab koodikirjutamise praktikaid.

Eesti keel koodis tekitab tunde, et seda juttu võiks kuulda noorte seast tänaval – põimunud inglise keelega. See ei ole eriti arusaadav, kuid popp (ropp) ja noortepärane.

vaade.PaneTootajaInfo(string.Format("{0} - {1} ", tootaja.VotaTaisnimi, tootaja.Iskukood));

See kood maitseb kibedalt ja hapult ning ainult gurmaanid võiksid sellest mõnu tunda.

Mõtle, et see inimene, kes su koodi loeb on sarimõrvar ja ta teab kus sa elad. Kas siis julgeksid ikka kirjutada samalaadselt kui enne? Kui julged, siis ei karda sa surma või kirjutad nii, et teised ei raevutse selle nägemisest. Lisaks see ei lehka see nii jubedalt, et nina ära kukuks.

Et paremini mõista, mida lähtekood öelda tahab, tuleks läbi lugeda Kent Beck’i raamat “Implementation patterns” [Amazon] [Krisostomus] – see kirjeldab kõige paremini pulbitsevat jõudu.

Pigem võtta jõu väljakutse vastu ning õppida kirjutama inglise keeles nagu raamistikud seda välja pakuvad. Raamistikuga ühte sulandumine peaks olema eesmärk.

Jaksu teile jõu tunnetamisega ja ärge pöörduge pimeduse poole – jälestuse jõud.