Tylko jeden komentarz
Defensywne programowanie w R
Colin Gillespie
Jumping Rivers
Nie wiem jak Państwo...
- Kod, który dziś jest oczywisty
- Często staje się znacznie mniej czytelny po kilku tygodniach
Komentarze
- Komentarze w kodzie R dodaje się za pomocą
# - Pisanie dobrych komentarzy jest trudniejsze, niż się wydaje!
# This is a comment
# The above comment isn't very helpful
# Or is it?
Wskazówka 1: Unikaj oczywistych komentarzy
- Trudno niekiedy ocenić, co jest oczywiste
- Na przykład komentarze
wyglądają rozsądnie# Loop through data sets for (dataset in datasets) { # Read in data set r <- read.csv(dataset) } - Ale są może nieco zbyt oczywiste
- Na przykład komentarze
Wskazówka 2: Unikaj komentarzy, które nigdy nie będą aktualizowane
Typowym przykładem są komentarze nagłówkowe na początku pliku
# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
- Tego rodzaju komentarze prawie nigdy nie są aktualizowane
- Zdarzyło mi się zobaczyć
# list of packages used: XXX, YYY
Wskazówka 3: Bądź konsekwentny
- Zawsze zaczynaj od pojedynczego
#lub podwójnego## - Zacznij od wielkiej litery – przestrzegaj zasad gramatyki
- Ostrożnie z żartami
- To, co jest dla Ciebie śmieszne, innych może urazić
- Pamiętaj, aby komentować kod, który "wygląda błędnie"
- Używaj # TODO lub # XXX do oznaczania przyszłych problemów
Czas na ćwiczenia!
Defensywne programowanie w R
