improve comments and code style, see #93

js/bloch-sphere/view/BlochSphereMeasurementArea.ts

@@ -1,8 +1,8 @@
 // Copyright 2025, University of Colorado Boulder
 
 /**
- * BlochSphereMeasurementArea is the node that contains the measurement area for the Bloch Sphere screen. It contains
- * the UI elements for controlling various aspects of the measurement that is to be performed.
+ * BlochSphereMeasurementArea is the Scenery Node that contains the measurement area for the Bloch Sphere screen. It
+ * contains the UI elements for controlling various aspects of the measurement that is to be performed.
  *
  * @author Agustín Vallejo
  * @author John Blanco (PhET Interactive Simulations)
@@ -46,7 +46,7 @@ type BlochSphereMeasurementAreaOptions = SelfOptions & WithRequired<NodeOptions,
 // constants
 const TIMES = MathSymbols.TIMES;
 
-// Nominal max width of texts, empirically determined
+// nominal max width of text elements, empirically determined
 const MAX_WIDTH = 200;
 
 export default class BlochSphereMeasurementArea extends Node {

js/bloch-sphere/view/BlochSphereNumericalEquationNode.ts

@@ -154,13 +154,13 @@ export default class BlochSphereNumericalEquationNode extends HBox {
           }
         }
 
-        // If showGlobalPhaseProperty is true and basis is X or Y,
-        // Show the factored out global phase e^{i phiPlus pi} over the entire state.
+        // If showGlobalPhaseProperty is true and basis is X or Y, show the factored out global phase e^{i phiPlus pi}
+        // over the entire state.
         let globalPhasePart = '';
         let finalEquation = `|${PSI}⟩ = ${upComponent}${plus}${downComponent}`;
         if ( showGlobalPhase && ( basis === StateDirection.X_PLUS || basis === StateDirection.Y_PLUS ) ) {
 
-          // Format the global phase as e^{i phiPlus pi} (factored out in front)
+          // Format the global phase as e^{i phiPlus pi} (factored out in front).
           phiPlus < 0 ? phiPlus += 2 : phiPlus;
           const globalPhaseString = Utils.toFixed( phiPlus, 2 );
           globalPhasePart = `e<sup>i${globalPhaseString}${PI}</sup> `;
@@ -176,10 +176,10 @@ export default class BlochSphereNumericalEquationNode extends HBox {
 
     super( options );
 
-    // Add the RichText equation node to this container
+    // Add the RichText equation node to this container.
     this.addChild( equationNode );
 
-    // This prevents the equation from resizing vertically on simplification
+    // This prevents the equation from resizing vertically on simplification.
     this.minContentHeight = this.height;
   }
 }

js/bloch-sphere/view/BlochSpherePreparationArea.ts

@@ -1,8 +1,8 @@
 // Copyright 2024-2025, University of Colorado Boulder
 
 /**
- * Zone where the Bloch Sphere direction is set by the user,
- * it includdes sliders for the polar and azimuthal angles and a ComboBox to select the direction.
+ * Zone where the Bloch Sphere direction is set by the user.  It includes sliders for the polar and azimuthal angles and
+ * a ComboBox to select the direction.
  *
  * @author Agustín Vallejo
  */
@@ -50,7 +50,8 @@ export default class BlochSpherePreparationArea extends VBox {
         majorTickLength: 10,
         constrainValue: value => Utils.roundToInterval( value, 5 / 180 * Math.PI ), // 5 degree intervals
         shiftKeyboardStep: 5 / 180 * Math.PI
-      } );
+      }
+    );
     const azimuthSlider = new Slider(
       model.preparationBlochSphere.azimuthalAngleProperty,
       model.preparationBlochSphere.azimuthalAngleProperty.range,
@@ -62,7 +63,8 @@ export default class BlochSpherePreparationArea extends VBox {
         majorTickLength: 10,
         constrainValue: value => Utils.roundToInterval( value, 5 / 360 * Math.PI * 2 ), // 5 degree intervals
         shiftKeyboardStep: 5 / 360 * Math.PI * 2
-      } );
+      }
+    );
 
     polarSlider.addMajorTick( 0, new Text( '0', { font: new PhetFont( 15 ) } ) );
     polarSlider.addMajorTick( Math.PI, new Text( `${MathSymbols.PI}`, { font: new PhetFont( 15 ) } ) );

js/bloch-sphere/view/MagneticFieldArrowNode.ts

@@ -18,7 +18,7 @@ export default class MagneticFieldArrowNode extends ArrowNode {
       stroke: 'black',
       fill: QuantumMeasurementColors.magneticFieldColorProperty,
 
-      // empirically determined values
+      // empirically determined values that define the shape of the arrow
       headHeight: 0.3 * maximumLength,
       headWidth: 0.4 * maximumLength,
       tailWidth: 0.15 * maximumLength

js/bloch-sphere/view/MagneticFieldControl.ts

@@ -111,7 +111,6 @@ export default class MagneticFieldControl extends Panel {
       } ),
       options
     );
-
   }
 }
 

js/bloch-sphere/view/MeasurementTimerControl.ts

@@ -1,8 +1,8 @@
 // Copyright 2025, University of Colorado Boulder
 
 /**
- * MeasurementTimerControl is the node that contains the UI elements for controlling the time at which the
- * Bloch Sphere is measured.
+ * MeasurementTimerControl is the node that contains the UI elements for controlling the time at which the Bloch Sphere
+ * is measured.
  *
  * @author Agustín Vallejo
  * @author John Blanco (PhET Interactive Simulations)
@@ -135,7 +135,6 @@ export default class MeasurementTimerControl extends Node {
     }, providedOptions );
 
     super( options );
-
   }
 }