Update comment formatting

Author: adamgraham

Assets/Scripts/Asteroid.cs

@@ -9,8 +9,7 @@
 public class Asteroid : MonoBehaviour
 {
     /// <summary>
-    /// An array of sprites of which one is randomly
-    /// assigned to the asteroid.
+    /// An array of sprites of which one is randomly assigned to the asteroid.
     /// </summary>
     [Tooltip("An array of sprites of which one is randomly assigned to the asteroid.")]
     public Sprite[] sprites;
@@ -40,8 +39,8 @@ public class Asteroid : MonoBehaviour
     public float movementSpeed = 50.0f;
 
     /// <summary>
-    /// The maximum amount of time the asteroid can
-    /// stay alive after which it is destroyed.
+    /// The maximum amount of time the asteroid can stay alive after which it is
+    /// destroyed.
     /// </summary>
     [Tooltip("The maximum amount of time the asteroid can stay alive after which it is destroyed.")]
     public float maxLifetime = 30.0f;
@@ -81,8 +80,7 @@ private void Start()
 
     public void SetTrajectory(Vector2 direction)
     {
-        // Move the asteroid along the trajectory
-        // factoring in its speed
+        // Move the asteroid along the trajectory factoring in its speed
         _rigidbody.AddForce(direction * this.movementSpeed);
     }
 
@@ -91,33 +89,31 @@ private void OnCollisionEnter2D(Collision2D collision)
         // Check if the asteroid was hit by a bullet
         if (collision.gameObject.tag == "Bullet")
         {
-            // Check if the asteroid is large enough to
-            // split in half (both parts must be greater
-            // than the minimum size)
+            // Check if the asteroid is large enough to split in half (both
+            // parts must be greater than the minimum size)
             if ((this.size * 0.5f) >= this.minSize)
             {
-                // Split the asteroid into two parts
-                // by creating two new asteroids
+                // Split the asteroid into two parts by creating two new
+                // asteroids
                 CreateSplit();
                 CreateSplit();
             }
 
-            // Inform the game manager the asteroid
-            // was destroyed so score can be calculated
+            // Inform the game manager the asteroid was destroyed so score can
+            // be calculated
             FindObjectOfType<GameManager>().AsteroidDestroyed(this);
 
-            // Destroy the current asteroid since it is
-            // either replaced by two new asteroid objects
-            // or small enough to be destroyed by the bullet
+            // Destroy the current asteroid since it is either replaced by two
+            // new asteroid objects or small enough to be destroyed by the
+            // bullet
             Destroy(this.gameObject);
         }
     }
 
     private Asteroid CreateSplit()
     {
-        // Set the new asteroid poistion to be the same
-        // as the current asteroid but with a slight offset
-        // so they do not spawn inside each other
+        // Set the new asteroid poistion to be the same as the current asteroid
+        // but with a slight offset so they do not spawn inside each other
         Vector2 position = this.transform.position;
         position += Random.insideUnitCircle * 0.5f;
 

Assets/Scripts/AsteroidSpawner.cs

@@ -1,8 +1,7 @@
 using UnityEngine;
 
 /// <summary>
-/// Continuously spawns asteroids and sets their
-/// initial trajectory.
+/// Continuously spawns asteroids and sets their initial trajectory.
 /// </summary>
 public class AsteroidSpawner : MonoBehaviour
 {
@@ -31,8 +30,8 @@ public class AsteroidSpawner : MonoBehaviour
     public int amountPerSpawn = 1;
 
     /// <summary>
-    /// The maximum angle in degrees the asteroid will
-    /// steer from its initial trajectory.
+    /// The maximum angle in degrees the asteroid will steer from its initial
+    /// trajectory.
     /// </summary>
     [Tooltip("The maximum angle in degrees the asteroid will steer from its initial trajectory.")]
     [Range(0.0f, 45.0f)]
@@ -48,22 +47,22 @@ public void Spawn()
     {
         for (int i = 0; i < this.amountPerSpawn; i++)
         {
-            // Choose a random direction from the center of the spawner
-            // and spawn the asteroid a distance away
+            // Choose a random direction from the center of the spawner and
+            // spawn the asteroid a distance away
             Vector2 spawnDirection = Random.insideUnitCircle.normalized;
             Vector3 spawnPoint = spawnDirection * this.spawnDistance;
 
-            // Offset the spawn point by the position of the spawner
-            // so its relative to the spawner location
+            // Offset the spawn point by the position of the spawner so its
+            // relative to the spawner location
             spawnPoint += this.transform.position;
 
-            // Calculate a random variance in the asteroid's rotation
-            // which will cause its trajectory to change
+            // Calculate a random variance in the asteroid's rotation which will
+            // cause its trajectory to change
             float variance = Random.Range(-this.trajectoryVariance, this.trajectoryVariance);
             Quaternion rotation = Quaternion.AngleAxis(variance, Vector3.forward);
 
-            // Create the new asteroid by cloning the prefab
-            // and set a random size within the range
+            // Create the new asteroid by cloning the prefab and set a random
+            // size within the range
             Asteroid asteroid = Instantiate(this.asteroidPrefab, spawnPoint, rotation);
             asteroid.size = Random.Range(asteroid.minSize, asteroid.maxSize);
 

Assets/Scripts/Bullet.cs

@@ -1,8 +1,7 @@
 using UnityEngine;
 
 /// <summary>
-/// Handles the physics/movement of a bullet
-/// projectile.
+/// Handles the physics/movement of a bullet projectile.
 /// </summary>
 [RequireComponent(typeof(Rigidbody2D))]
 [RequireComponent(typeof(BoxCollider2D))]
@@ -15,8 +14,8 @@ public class Bullet : MonoBehaviour
     public float speed = 500.0f;
 
     /// <summary>
-    /// The maximum amount of time the bullet will
-    /// stay alive after being projected.
+    /// The maximum amount of time the bullet will stay alive after being
+    /// projected.
     /// </summary>
     [Tooltip("The maximum amount of time the bullet will stay alive after being projected.")]
     public float maxLifetime = 10.0f;
@@ -34,8 +33,8 @@ private void Awake()
 
     public void Project(Vector2 direction)
     {
-        // Move the bullet in the desired direction
-        // while factoring in the speed of the bullet
+        // Move the bullet in the desired direction while factoring in the speed
+        // of the bullet
         _rigidbody.AddForce(direction * this.speed);
 
         // Destroy the bullet after it reaches its max lifetime

Assets/Scripts/GameManager.cs

@@ -2,8 +2,8 @@
 using UnityEngine.UI;
 
 /// <summary>
-/// Manages the state of the game, such as
-/// scoring, dying, and starting a new game.
+/// Manages the state of the game, such as scoring, dying, and starting a new
+/// game.
 /// </summary>
 public class GameManager : MonoBehaviour
 {
@@ -14,8 +14,8 @@ public class GameManager : MonoBehaviour
     public Player player;
 
     /// <summary>
-    /// The particle effect that is played when an
-    /// asteroid is destroyed and when the player dies.
+    /// The particle effect that is played when an asteroid is destroyed and
+    /// when the player dies.
     /// </summary>
     [Tooltip("The particle effect that is played when an asteroid is destroyed and when the player dies.")]
     public ParticleSystem explosionEffect;
@@ -82,8 +82,7 @@ public void NewGame()
 
     public void Respawn()
     {
-        // Move the player back to the center
-        // and reactivate their controls
+        // Move the player back to the center and reactivate their controls
         this.player.transform.position = Vector3.zero;
         this.player.gameObject.SetActive(true);
     }
@@ -106,8 +105,7 @@ public void AsteroidDestroyed(Asteroid asteroid)
 
     public void PlayerDeath(Player player)
     {
-        // Play the explosion effect at the
-        // location of the player
+        // Play the explosion effect at the location of the player
         this.explosionEffect.transform.position = player.transform.position;
         this.explosionEffect.Play();