Γνώμες/Πρακτικές για "σωστό" και "καθαρό" κώδικα

[noasgr]

Παίδες γεια χαρά. Παλεύω δειλά δειλά μια σελίδα στατικού περιεχομένου και σκέφτηκα να ζητήσω την γνώμη σας σχετικά με το πόσο "σωστά" είναι γραμμένος ο κώδικας.

 

Είναι καλοδεχούμενες κάθε είδους παρατηρήσεις πχ "καλό θα ήταν να βάζεις κανα σχόλιο γιατί κάποια στιγμή θα χάσεις τη μπάλα", "το συγκεκριμένο κομμάτι είναι τελείως λάθος για τον χ ψ λόγο, το σωστό θα ήταν.." Αναφέρομαι κυρίως σε HTML και CSS..

 

Ελπίζω να μην σας βγουν τα μάτια με αυτά που θα δείτε, σας ευχαριστώ πολύ για την βοήθεια εκ των προτέρων!!

 

Link

[panospc]

Ρίξε μια ματιά σ' αυτό το site http://uitest.com/en/check/

βάζεις το link της σελίδας και σου δίνει μια λίστα με διάφορα online test για να ελέγξεις το κατά πόσο είναι σωστός ο κώδικας σου

[1lj4z1]

Εγώ αυτό που κάνω (και δεν κάνουν πολύ) είναι οτι ξεκαθαρίζω με δυο απλούς τρόπους τον κώδικα μου (πάσης φύσεως)...

 

1. Σε γλώσσες που έχουνε συνήθως αρχή-τέλος με την μορφή begin-end ή brackets { }, βάζω πάντα την ιδιότητα σαν τίτλος και απο κάτω τα brackets ασ πούμε, για να φαίνετε ξεκάθαρα που αρχίζει και που τελειώνει κάτι... για παράδειγμα οι περισσότεροι γράφουν έτσι:

>
   if x > 4 {
   bla bla bla bla bla....
   }

εγώ γράφω έτσι (ώστε να είναι ξεκάθαρο απλά επειδή βρίσκεται στην ίδια ευθεία οτι τελειώνει εκεί...:

>
   if x > 4
       {
           bla bla bla bla bla
       }

2. Βάζω comments σαν γενικό τίτλο λειτουργίας του κώδικα που βρίσκεται απο κάτω ή όπου χρειάζεται:

>
   //τσεκάρει άμα η μεταβλητή x είναι μεγαλύτερη του 4...
   if x > 4
		{
			//κάνει bla bla bla
			bla bla bla bla bla
		}

 

Κώδικας απο πρόγραμμα που έχω γράψει, ψάχνει για λέξεις που έχει στείλει ο χρήστης απο φόρμα html, επαφές αποθηκευμένες σε αρχείο.

>

<?php
   //variables initialization and value assignment with $_post values
    $fname=""; if($_POST["fname"]) $fname=$_POST["fname"];
    $lname=""; if($_POST["lname"]) $lname=$_POST["lname"];

    //file open and enable read mode
    $file=fopen("address_book.txt", "r");

    //$found variable set to 0
    $found=0;

    //check if $fname and $lname have values
    if((!$fname) or (!$lname))
         {
              echo "please input both first name and last name.";
              exit;
         }

    //while pointer isn't on the eof do the following magic:
    while(!feof($file))
         {
              //get line from file and assign it to $line
              $line=fgets($file);
		
              //explode $line items and assign each to $items
              $items=explode(",", $line);
		
              //check if variables $fname and $lname have values
              if(($fname) and ($lname))
                   {
                        //check of $_post values exist in $items variable
                        if((strstr($items[0], $fname)) and (strstr($items[1], $lname)))
                             {
                                  //echo contact
                                  echo $items[0]." ".$items[1]." ".$items[2]."<br />";
						
                                  //$found variable set to 1
                                  $found=1;
                             }
                   }	
         }
	
    if ($found==0)
         {
              echo "contact not found.";
         }
?>

[thanocaster]

Φίλε 1lj4z1,

πολύ καλά όλα αυτά που λες και σωστά, απλά μια ένσταση: Στα σχόλια στον κώδικα μην βάζεις τί κάνει ο κώδικας, αλλά γιατί κάνεις ότι κάνεις. Κοινώς, αντί να γράψεις:

>
// $found variable set to 0
$found = 0;

Είναι προτιμότερο να γράψεις:

>
// Initialise variable to count matches
$found = 0;

Αυτό διότι, στο μέλλον θα βλέπεις πως η μεταβλητή found μηδενίζεται. Δεν χρειάζεσαι το σχόλιο για να το καταλάβεις. Αυτό που χρειάζεται να καταλάβεις, είναι τί είναι αυτή η μεταβλητή και γιατί την χρησιμοποιείς.

[ippo00]

Γενικά τα πολλά comments αρχίζουν και γίνονται πρόβλημα. Αν κανείς χρειάζεται τόσα comments τότε απλά δεν ξέρει php