Kommentarer är av ondo
Jag lyckades helt spåra ur en tråd på r/gamedev då jag påstod helt ärligt att kommentarer är av ondo och bara juniorer använder dem i domänen.
Det var många som höll med mig men lika många som inte gjorde det. Personligen tycker jag det bara är brus, kommentarer blir snabbt utdaterade och det är bättre se till att hålla koden på en kvalite som gör den självdokumenterande. På sin höjd använda det för lågnivåkod som algoritmer och shaders.
Bra artikel
https://medium.freecodecamp.org/code-comments-the-good-the-ba...
På kul tittade jag genom vår kod och på ett enda ställe i domänen (spelets gamelogic) hittade jag en kommentar
public class PumpActionSlide : FirearmAction
{
private bool actionReleasePressed;
protected override void Update()
{
base.Update();
CanAttach = firearm.IsAttachedToAnyMover;
if (IsAttached && (!firearm.HammerCocked || actionReleasePressed || !Locked))
{
MoveRelativeToHand();
}
}
public override void CheckForPlayerCommands(NVRHand hand)
{
actionReleasePressed = hand.CheckForPlayerCommand(Command.ReleaseAction);
}
public override void ReleaseLock()
{
}
public override void FirearmFired()
{
}
public override bool CanReleaseLock
{
get
{
return false;
}
}
public override void OnReachedStart()
{
SlideReturned();
RequestSlideReturned();
}
public override void OnReachedEnd()
{
base.OnReachedEnd();
firearm.IndexNewBullet();
//TODO: a bit of a hack, A pump action shotgun works different from other firearms, the shell must be in the tube when the action goes back. Otherwise it will not be indexed into the chamber.
//However, firearm.IndexNewBullet() will index the shell into the chamber which is not true, in reality its first index into the action slider and then chambered when the slide goes forward
//Also at somepoint we should make a more complex statemachine that shows the shell/bullet transfer from tube/mag to chamber. Mosy imporant for manual bolt and pump action slides. But any slide being pulled by hand should animate transfer of bullet/shell
}
public override void SlideReturned(bool playsound = true)
{
transform.position = SlideStartPoint.position;
base.OnReachedStart();
if(playsound)
{
PlayClose();
}
}
protected override bool Locked { get { return transform.localPosition == SlideStartPoint.localPosition; } }
}
Så vad tycker ni om kommentarers vara eller icke vara?
