Recently found out that /// in Visual Studio is used to create Xml documentation. Also found out, you can view the description of the functions using the <summary> .

Question. Do the <returns> and <param name="_name_"> tags work? Because when you add them to the code, the description does not change.

Code example:

 /// <summary> /// ЗаполняСт массива Π΄ΠΎ ΠΊΠΎΠ½Ρ†Π° Π΄Ρ€ΡƒΠ³ΠΎΠΉ Ρ‡Π°ΡΡ‚ΡŒΡŽ массива /// </summary> /// <param name="arr">массив Ρ‚Ρ€Π΅Π±ΡƒΡŽΡ‰ΠΈΠΉ заполнСния</param> /// <param name="fullArr">массив, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ заполняСт arr</param> /// <param name="startPos">с ΠΊΠ°ΠΊΠΎΠΉ ΠΏΠΎΠ·ΠΈΡ†ΠΈΠΈ Π·Π°ΠΏΠΎΠ»Π½ΡΡ‚ΡŒ</param> /// <returns>Π·Π°ΠΏΠΎΠ»Π½Π΅Π½Π½Ρ‹ΠΉ массив</returns> dynCharArr fillEndOfArr(dynCharArr arr, dynCharArr fullArr, int startPos) { for (int i = startPos; i < fullArr.len; ++i) arr.arr[startPos + i] = fullArr.arr[i]; return arr; } 

What is displayed in Visual Studio

When you hover on a function

When entering parameters

UPD Noticed yet such a problem as a complete lack of description in the Object Browser.

  • should work like, quotes in the examples are single only. Rather, in the example, then just double, and in the description of the syntax single. Reopen the mb file just? - teran
  • @teran Not really understood with quotes. Judging by the docks, they should be double. I noticed one more thing in the Object Browser window; the description is missing completely. - Andrey Tkachuk

0