Visa signatur
Kommentarer är av ondo
Visa signatur
Visa signatur
Citera mig för svar.
Arch Linux
Visa signatur
Välkommen till Sweclockers F1 fantasy Kod 476f003b55
Visa signatur
"The more you learn, the more you realize how little you know."
Visa signatur
Citera mig för svar.
Arch Linux
Visa signatur
Visa signatur
Visa signatur
Visa signatur
Visa signatur
Visa signatur
Gigabyte Aorus Master | 32gb DDR4 3466MHZ CL14 | Ryzen 3950X | 3080Ti
En lång rad Intel system som barnen fått som speldatorer, VR-dator, massa bärbara, servrar, RPi's och andra boxar :P
Visa signatur
Hur kan syltkakor överleva i det vilda utan ögon?
Visa signatur
Välkommen till Sweclockers F1 fantasy Kod 476f003b55
Visa signatur
Gigabyte Aorus Master | 32gb DDR4 3466MHZ CL14 | Ryzen 3950X | 3080Ti
En lång rad Intel system som barnen fått som speldatorer, VR-dator, massa bärbara, servrar, RPi's och andra boxar :P
Visa signatur
Dator 1: | i9 9900k | MSI RTX 4080 Ventus 3x OC | ASUS ROG STRIX Z390-F Gaming | Corsair LPX DDR4 32 GB 3200Mhz | FD define S | Samsung 850 EVO 1TB | Samsung 980 NVMe M.2 1TB | Noctua NH-U12S | Corsair RM750x 750W | Windows 10
Skärm 1: ASUS 27" ROG SWIFT PG279Q 1440p @ 165Hz/IPS/G-Sync
Skärm 2: ASUS 27" TUF VG27AQ1A 1440p @ 170Hz/IPS/G-Sync/HDR
Visa signatur
The variable 'brain' is declared but never used
Visa signatur
5950X, 3090
Visa signatur
Visa signatur
Det jag tycker många av er missar, även om jag inte helt håller med TS, är att han förespråkar god dokumentation UTANFÖR koden, något jag faktiskt håller med om.
När jag arbetade i ett stort projekt här för ett tag sedan, (hemsida - databas - applikation), så la vi otroligt mycket tid på att skriva API'er för hur varje del fungerade. Behövde man koppla något till databasen? Då fanns det API. Behövde man ändra något i appen? Då fanns det dokumentation - allt detta var utanför koden.
Visst, jag använder faktiskt också kommentarer ibland för att förklara viktiga saker, (inte för mitt eget bruk utan för andra personer). Men att komma till ett projekt med god dokumentation, bra API och lättnavigerade filer/mappar gör att jag sover bra om nätterna.
Något som vår scrummaster sa i början av projektet, (ja, en sån ska man tydligen ha nu för tiden), var att koden ska vara självkommenterande. Det var lite jobbigt till en början men som jag skrev tidigare i texten så underlättade det enormt senare.
Exempel på wiki från databasen:
Visa signatur
Gaming: RTX 2070 & 3770k
Studier: MacBook pro retina 13
Ljud: QH-1339 & ett par rackans smidiga AirPods
Telefon: iPhone 6s plus
Skärm: ASUS 27" ROG Swift PG279Q med sån där g-sync
Att bara juniora utvecklare skulle använda kommentarer är komplett bullshit. Självklart ska man skriva självdokumenterande kod, och kommentarer som inte beskriver mer än vad koden själv beskriver är såklart onödiga, men det finns massor av situationer som kommentarer är riktigt bra att ha, speciellt i språk som tex. Java där IDE'er hanterar kommentarer som Javadoc och visar dessa när man mouse-over'ar metoder etc, ett par exempel:
1. Dokumentation för klasser och interfaces som det är tanken att andra utvecklare ska använda. Det är så sjukt mycket smidigare att ha det direkt i koden istället för på något extern ställe eftersom ens IDE kan hjälpa en att få upp det så snabbt. Snabbt exempel plockat från Google's Gson lib i Java:
/**
* This method deserializes the specified Json into an object of the specified class. It is not
* suitable to use if the specified class is a generic type since it will not have the generic
* type information because of the Type Erasure feature of Java. Therefore, this method should not
* be used if the desired type is a generic type. Note that this method works fine if the any of
* the fields of the specified object are generics, just the object itself should not be a
* generic type. For the cases when the object is of generic type, invoke
* {@link #fromJson(String, Type)}. If you have the Json in a {@link Reader} instead of
* a String, use {@link #fromJson(Reader, Class)} instead.
*
* @param <T> the type of the desired object
* @param json the string from which the object is to be deserialized
* @param classOfT the class of T
* @return an object of type T from the string. Returns {@code null} if {@code json} is {@code null}.
* @throws JsonSyntaxException if json is not a valid representation for an object of type
* classOfT
*/
public <T> T fromJson(String json, Class<T> classOfT) throws JsonSyntaxException {
Object object = fromJson(json, (Type) classOfT);
return Primitives.wrap(classOfT).cast(object);
}
Exempel på hur Eclipse visar detta när man mouse-over'ar respektive vid code completion:
2. Omvandling av enheter för att det snabbare ska gå att förstå av en människa:
private static final int SLEEP_DURATION_MS = 1000 * 60 * 60; // 1 hour
3. Förklaring för deprecated metoder och vad som ska användas istället:
/**
* @deprecated Use the {@link #getFullName() getFullName} method instead.
*/
@Deprecated
public String getName() {
return this.firstName + " " + this.surname;
}
4. Förklara design-val som är för komplexa att förklara genom koden i sig, och som inte är självklara av att bara titta på koden:
public UnitData(Unit unit)
{
this.unitId = unit.getId();
this.owner = unit.owner;
// Creating a new Position instead of just using unit's position is needed because getPosition returns a Hexagon object which is an extension of the Position class.
// The Hexagon itself has a reference to the unit on it which causes a stack overflow when gson tries to serialize this object.
// As such we need to create a simple Position-copy of the Hexagon only retaining its coordinates.
this.position = new Position(unit.getPosition().x, unit.getPosition().y);
this.hitpoints = unit.hitpoints;
}
Visa signatur
Intel i7-7700k @ 4.9Ghz - Noctua NH-U12P SE2 - MSI GTX 1070 Armor OC - AsRock Z270 Extreme4 - G.Skill Ripjaws V DDR4 3200MHz CL16 2x8GB - Corsair RM750x 750W - Samsung 970 EVO 500GB - Acer Predator X34 - Silverstone RV02-E - Asus Xonar Essence STX II 7.1 - Mionix Naos 8200 - Corsair Gaming MM400 - Das Keyboard 4 Ultimate MX Brown - Beyerdynamic DT990 Pro 250 Ohm - Antlion ModMic 4.0 Unidirectional
