Προσθήκη σχολίων στην ASP

• Απρίλιος 29, 2024

Μερικές φορές είναι τα απλά πράγματα που συγχέουν τους ανθρώπους. Πώς προσθέτετε σχόλια στον κώδικα ASP, ώστε να είναι πιο ευανάγνωστο και τεκμηριωμένο;

Είναι πολύ εύκολο - απλά βάζετε ένα μοναδικό απόσπασμα (') στην αρχή της γραμμής σας ASP. Έτσι ο κώδικας μπορεί να φαίνεται έτσι -

'προετοιμασία μεταβλητών'
CurrMonth = αίτημα ("m")
CurrDay = αίτημα ("d")

Σημειώστε ότι έβαλα ένα απόστροφο πριν και μετά το σχόλιό μου. Δεν χρειάζεται να το κάνετε αυτό. Χρησιμοποιώ όμως τον επεξεργαστή TextPad (τον οποίο συνιστώ ανεπιφύλακτα) και αυτόματα τονίζει τα πράγματα με βάση το πού αρχίζει και τελειώνει ένα απόστροφο. Έτσι, τοποθετώντας ένα σε κάθε άκρο των σχολίων μου, τα μετατρέπω όλα σε ένα διαφορετικό χρώμα.

Τα σχόλια ΔΕΝ ερμηνεύονται έτσι ώστε να μπορείτε να τα βάζετε ό, τι θέλετε σε αυτά. Ωστόσο, ενώ τα σχόλια είναι σημαντικά για να παρακολουθείτε τι κάνετε, δεν συνιστώ να βάζετε έναν τόνο σχολίων στον κώδικα σας. Να θυμάστε ότι ολόκληρο το αρχείο σας πρέπει να αναλύεται και να επεξεργάζεται προτού το αποτέλεσμα αποσταλεί στον τελικό χρήστη. Εάν γράφετε τον πόλεμο και την ειρήνη στα σχόλιά σας, θα χρειαστεί λίγος χρόνος πριν το αρχείο φτάσει στον τελικό σας χρήστη - κάτι που σημαίνει ότι θα μπορούσαν να εγκαταλείψουν και να πάνε αλλού. Θέλετε οι ζωντανές σελίδες σας ASP να είναι όσο το δυνατόν εξορθολογισμένες.

Γι 'αυτό συνιστούμε να βάζετε σχόλια πάνω από κάθε σημαντικό μπλοκ κώδικα, οπότε αν πρέπει να εισέλθετε και να εντοπίσετε σφάλματα μήνες αργότερα μπορείτε να θυμηθείτε τι κάνατε. Ίσως προσθέσετε μια γραμμή ή δύο στην κορυφή με την τελευταία ημερομηνία αλλαγής και το όνομα του συγγραφέα. Αφήστε όμως όλα τα ισχυρά έγγραφα ξεχωριστά. Ο πρωταρχικός σκοπός του κώδικα ASP στο τέλος είναι να δημιουργηθεί μια ιστοσελίδα για έναν χρήστη - και υπό αυτή την έννοια, η γρήγορη δράση είναι πρωταρχικής σημασίας.

Οδηγίες Βίντεο: Elite Dangerous Krait Phantom released 1st Flight and thoughts (Απρίλιος 2024).