описания методов объекта

(cherry picked from commit 24a9f27)

Author: Mr-Rm

src/OneScript.StandardLibrary/Collections/ArrayImpl.cs

@@ -15,6 +15,11 @@ This Source Code Form is subject to the terms of the
 
 namespace OneScript.StandardLibrary.Collections
 {
+    /// <summary>
+    /// Коллекция элементов произвольного типа.
+    /// Возможно обращение к значениям элементов по числовому индексу (нумерация начинается с 0).
+    /// Доступен обход в цикле <c>Для Каждого Из</c>.
+    /// </summary>
     [ContextClass("Массив", "Array")]
     public class ArrayImpl : AutoCollectionContext<ArrayImpl, IValue>, IValueArray
     {
@@ -61,16 +66,23 @@ public override void SetIndexedValue(IValue index, IValue val)
                 Set((int)index.AsNumber(), val);
             else
                 base.SetIndexedValue(index, val);
-        }
-
+        }
+
         #region ICollectionContext Members
-        
+
+        /// <summary>
+        /// Получает количество элементов в массиве
+        /// </summary>
+        /// <returns>Количество элементов массива</returns>
         [ContextMethod("Количество", "Count")]
         public override int Count()
         {
             return _values.Count;
-        }
-
+        }
+
+        /// <summary>
+        /// Удаляет все элементы из массива
+        /// </summary>
         [ContextMethod("Очистить", "Clear")]
         public void Clear()
         {
@@ -87,16 +99,27 @@ public override IEnumerator<IValue> GetEnumerator()
             {
                 yield return item;
             }
-        }
-
+        }
+
         #endregion
-
+
+        /// <summary>
+        /// Добавляет элемент в конец массива
+        /// </summary>
+        /// <param name="value">Произвольный: Добавляемое значение. Если не указано, то добавляется Неопределено</param>
         [ContextMethod("Добавить", "Add")]
         public void Add(IValue value = null)
         {
            _values.Add(value ?? ValueFactory.Create());
-        }
-
+        }
+
+        /// <summary>
+        /// Вставляет значение в массив по указанному индексу
+        /// </summary>
+        /// <param name="index">Число: Индекс вставляемого значения.
+        /// Если индекс превышает размер массива, то массив дополняется элементами Неопределено до указанного индекса.
+        /// Если индекс отрицательный, то выбрасывается исключение</param>
+        /// <param name="value">Произвольный: Вставляемое значение. Если не указано, то вставляется Неопределено</param>
         [ContextMethod("Вставить", "Insert")]
         public void Insert(int index, IValue value = null)
         {
@@ -109,13 +132,24 @@ public void Insert(int index, IValue value = null)
             _values.Insert(index, value ?? ValueFactory.Create());
         }
 
+        /// <summary>
+        /// Выполняет поиск элемента в массиве
+        /// </summary>
+        /// <param name="what">Произвольный: Искомое значение</param>
+        /// <returns>Если элемент найден, возвращается его индекс, иначе Неопределено</returns>
         [ContextMethod("Найти", "Find")]
         public IValue Find(IValue what)
         {
             var idx = _values.FindIndex(x => x.StrictEquals(what));
             return idx>=0 ? ValueFactory.Create(idx) : ValueFactory.Create();    
-        }
-
+        }
+
+        /// <summary>
+        /// Удаляет значение из массива
+        /// </summary>
+        /// <param name="index">Число: Индекс удаляемого элемента.
+        /// Если индекс находится за границами массива, то выбрасывается исключение
+        /// </param>
         [ContextMethod("Удалить", "Delete")]
         public void Remove(int index)
         {
@@ -125,21 +159,39 @@ public void Remove(int index)
             _values.RemoveAt(index);
         }
 
+        /// <summary>
+        /// Получает наибольший индекс элемента массива
+        /// </summary>
+        /// <returns>Наибольший индекс в массиве. Если количество элементов массива равно 0, возвращает -1</returns>
         [ContextMethod("ВГраница", "UBound")]
         public int UpperBound()
         {
             return _values.Count - 1;
-        }
-
+        }
+
+        /// <summary>
+        /// Получает значение из массива по индексу
+        /// </summary>
+        /// <param name="index">Число: Индекс элемента.
+        /// Если индекс находится за границами массива, то выбрасывается исключение
+        /// </param>
+        /// <returns>Значение элемента массива</returns>
         [ContextMethod("Получить", "Get")]
         public IValue Get(int index)
         {
             if (index < 0 || index >= _values.Count)
                 throw RuntimeException.IndexOutOfRange();
 
             return _values[index];
-        }
-
+        }
+
+        /// <summary>
+        /// Устанавливает значение в массиве по индексу
+        /// </summary>
+        /// <param name="index">Число: Индекс элемента.
+        /// Если индекс находится за границами массива, то выбрасывается исключение
+        /// </param>
+        /// <param name="value">Произвольный: Устанавливаемое значение</param>
         [ContextMethod("Установить", "Set")]
         public void Set(int index, IValue value)
         {