Implement find function to locate character index in string with detailed comments and explanations

Author: HoussamLh

Sprint-3/4-stretch-investigate/find.js

@@ -1,25 +1,33 @@
 function find(str, char) {
+  // Start searching from the first character (index 0)
   let index = 0;
 
+  // Continue looping while index is less than the length of the string
+  // This prevents us from going beyond the last character of the string
   while (index < str.length) {
+    // Check if the current character matches the one we are looking for
     if (str[index] === char) {
+      // If found, return the current index position
       return index;
     }
-    index++;
+    // Move to the next character in the string
+    index++; // This increments index by 1, so the loop moves through each character
   }
+
+  // If we finish the loop without finding the character, return -1
+  // This means the character does not exist in the string
   return -1;
 }
 
-console.log(find("code your future", "u"));
-console.log(find("code your future", "z"));
-
-// The while loop statement allows us to do iteration - the repetition of a certain number of tasks according to some condition
-// See the docs https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/while
+// Test examples:
+console.log(find("code your future", "u")); // Should output the first index of 'u'
+console.log(find("code your future", "z")); // Should output -1 since 'z' is not in the string
 
-// Use the Python Visualiser to help you play computer with this example and observe how this code is executed
-// Pay particular attention to the following:
+/*
+Explanation:
+a) The 'index' variable starts at 0 and increments by 1 each loop (index++), allowing the function to check each character in the string.
+b) The 'if' statement checks whether the current character (str[index]) matches the character we're searching for.
+c) 'index++' is used to move forward to the next character in the string on each loop iteration.
+d) The condition 'index < str.length' ensures the loop only runs while 'index' is a valid position inside the string, preventing errors.
+*/
 
-// a) How the index variable updates during the call to find
-// b) What is the if statement used to check
-// c) Why is index++ being used?
-// d) What is the condition index < str.length used for?