Boardnews ShowRoom

Es gibt 3 Antworten in diesem Thema. Der letzte Beitrag () ist von Marcus Gräfe.

    Boardnews ShowRoom

    05.01.12: Bibliotheken im Showroom - Klassendiagramm statt Screenshot

    @Markus:
    oder ihr macht die Übersicht in Textform.

    Definiere: "Textform" ...

    Folgendes ist "Text" und eine PERFEKTE Beschreibung:
    Spoiler anzeigen

    Weil es nämlich die XML Comments aus dem Sourcecode sind!

    XML-Quellcode

    1. <?xml version="1.0"?>
    2. <doc>
    3. <assembly>
    4. <name>
    5. NTHLibrary
    6. </name>
    7. </assembly>
    8. <members>
    9. <member name="M:NTHLibrary.StringExtensions.Contains(System.String,System.String,System.StringComparison)">
    10. <summary>
    11. Checks if a string contains another string
    12. </summary>
    13. <param name="s">Source string</param>
    14. <param name="find">String to find</param>
    15. <param name="cmp">Compare option</param>
    16. <returns>TRUE if the find-string was found, FALSE if not</returns>
    17. <remarks>For whatever reason, Contains() lacks the possibility to
    18. define how to compare the string objects - like ignore case etc. This
    19. function simply maps the indexof function which DOES have this
    20. ability</remarks>
    21. </member><member name="M:NTHLibrary.StringExtensions.LevenshteinDistance(System.String,System.String)">
    22. <summary>
    23. Calculates the Levenshtein distance of two strings
    24. </summary>
    25. <param name="source">String 1</param>
    26. <param name="target">String 2</param>
    27. <returns>Levenshtein distance</returns>
    28. <remarks>C# sample ported to VB.Net
    29. Original: http://www.merriampark.com/ldcsharp.htm
    30. </remarks>
    31. </member><member name="T:NTHLibrary.StringExtensions">
    32. <summary>
    33. Extension methods for "String"
    34. </summary>
    35. <remarks></remarks>
    36. </member><member name="M:NTHLibrary.IComparableExtensions.IsInGroup``1(``0,``0[])">
    37. <summary>
    38. Determines if an object/value is one of the other objects/values
    39. </summary>
    40. <typeparam name="T">Generic Type</typeparam>
    41. <param name="obj">Object/value to test</param>
    42. <param name="group">A bunch of objects</param>
    43. <returns>TRUE if obj is inside the group, FALSE if not.</returns>
    44. <remarks>This is just the reverse function to <c>If Something.Contains()</c></remarks>
    45. <overloads>Check if a value falls into a group</overloads>
    46. <see cref="!:Overload:NTHLibrary.IComparableExtensions.IsInGroup(T,IEnumerable(Of T)"/>
    47. </member><member name="M:NTHLibrary.IComparableExtensions.IsInGroup``1(``0,System.Collections.Generic.IEnumerable{``0})">
    48. <summary>
    49. foo
    50. </summary>
    51. <typeparam name="T"></typeparam>
    52. <param name="obj"></param>
    53. <param name="l"></param>
    54. <returns></returns>
    55. <remarks></remarks>
    56. <see cref="!:Overload:NTHLibrary.IComparableExtensions.IsInGroup(T,IEnumerable(Of T)"/>
    57. </member><member name="M:NTHLibrary.IComparableExtensions.IsInRange``1(``0,``0,``0)">
    58. <summary>
    59. Determines whether a value falls into a given range. Both boundaries are included.
    60. </summary>
    61. <typeparam name="T">Type of the value</typeparam>
    62. <param name="value">object to test</param>
    63. <param name="lowerboundary">lower boundary to test</param>
    64. <param name="upperboundbary">upper boundary to test</param>
    65. <returns>TRUE if the value falls into the given range. FALSE if not or
    66. if upperboundary is lower than lower boundary</returns>
    67. <remarks></remarks>
    68. </member><member name="T:NTHLibrary.IComparableExtensions">
    69. <summary>
    70. Extension methods that belong to IComparable
    71. </summary>
    72. <remarks></remarks>
    73. </member><member name="T:NTHLibrary.NamespaceDoc">
    74. <summary>
    75. The NTHLibrary is a compilation of some nice to have pieces of code ;)
    76. </summary>
    77. <remarks>tOdO</remarks>
    78. </member><member name="M:NTHLibrary.VariousExtensions.Assign``1(``0@,``0)">
    79. <summary>
    80. Assigns the given object to the original object and returns the new object
    81. </summary>
    82. <typeparam name="TSource">Generic Type</typeparam>
    83. <param name="oldVal">original object</param>
    84. <param name="newVal">new object</param>
    85. <returns>new value of original object</returns>
    86. <remarks></remarks>
    87. <example>
    88. <code lang="VB">
    89. Dim i As Integer = 1
    90. Dim j As Integer = 2
    91. If i.Assign(j) = 2 Then
    92. DoSomething()
    93. End If
    95. Dim s As New IO.StreamReader("myfile")
    96. Dim l As String = String.Empty
    97. While l.Assign(s.ReadLine).Length &gt; 0
    98. ' that means we can assign AND check in ONE simple instruction!
    99. End While
    100. </code>
    101. </example>
    102. </member><member name="M:NTHLibrary.VariousExtensions.Assign``1(``0@,``0,System.Predicate{``0})">
    103. <summary>
    104. Assigns the given object to the original object if <c>OnCondition()</c> returns <c>true</c> and returns the new object
    105. </summary>
    106. <typeparam name="TSource">Generic Type</typeparam>
    107. <param name="oldVal">original object</param>
    108. <param name="newVal">new object</param>
    109. <param name="OnCondition">A function that takes a single parameter of type <c>TSource</c> and returns a boolean</param>
    110. <returns>new value of original object</returns>
    111. <remarks></remarks>
    112. </member><member name="M:NTHLibrary.VariousExtensions.Swap``1(``0@,``0@)">
    113. <summary>
    114. Swaps the instance with the given object of the same type
    115. </summary>
    116. <typeparam name="TSource">generic type</typeparam>
    117. <param name="a">first object</param>
    118. <param name="b">second object</param>
    119. <returns>new value of instance</returns>
    120. <remarks>Swapping two values or objects isn't nuclear science, though it
    121. makes sense to have a handy little function that deals with it</remarks>
    122. </member><member name="M:NTHLibrary.VariousExtensions.IfNothing``1(``0@,``0)">
    123. <summary>
    124. Returns a defined value if the instance object is nothing (null in C#)
    125. </summary>
    126. <typeparam name="T">generic type</typeparam>
    127. <param name="o">instance object of type T</param>
    128. <param name="value">object of type T to return if o is nothing</param>
    129. <returns>o otherwise value if o is nothing</returns>
    130. <remarks>This is a kind of a shortcut function to avoid constructions like
    131. <code lang="VB">If Something Is Nothing Then Something = SomethingElse</code>
    132. Might be helpfull esp. in methods with optional parameters that default to nothing
    133. but have to be set to an instance inside the method</remarks>
    134. <code lang="VB">foo()</code>
    135. </member><member name="T:NTHLibrary.VariousExtensions">
    136. <summary>
    137. All extensions that did not fit somewhere else ;)
    138. </summary>
    139. <remarks>tOdO</remarks>
    140. </member><member name="T:NTHLibrary.PseudoRNG.NamespaceDoc">
    141. <summary>
    142. Everything that has to do with Pseudo Random Number Generators: PRNG
    143. </summary>
    144. <remarks>tOdO</remarks>
    145. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.Next">
    146. <summary>
    147. Returns a nonnegative random number.
    148. </summary>
    149. <returns>A 32-bit signed integer greater than or equal to zero and less than <c>system.int32.maxvalue</c></returns>
    150. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.Next(System.Int32)">
    151. <summary>
    152. Returns a nonnegative random number less than the specified maximum.
    153. </summary>
    154. <param name="maxValue">The exclusive upper bound of the random number to be generated. maxValue must be greater than or equal to zero. </param>
    155. <returns>A 32-bit signed integer greater than or equal to zero, and less than maxValue; that is, the range of return values ordinarily includes zero but not maxValue. However, if maxValue equals zero, maxValue is returned.</returns>
    156. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.Next(System.Int32,System.Int32)">
    157. <summary>
    158. Returns a random number within a specified range.
    159. </summary>
    160. <param name="minValue">The inclusive lower bound of the random number returned.</param>
    161. <param name="maxValue">The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue.</param>
    162. <returns>A 32-bit signed integer greater than or equal to minValue and less than maxValue; that is, the range of return values includes minValue but not maxValue. If minValue equals maxValue, minValue is returned.</returns>
    163. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.NextBytes(System.Byte[])">
    164. <summary>
    165. Fills the elements of a specified array of bytes with random numbers.
    166. </summary>
    167. <param name="buffer">An array of bytes to contain random numbers.</param>
    168. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.NextDouble">
    169. <summary>
    170. Returns a random number between 0.0 and 1.0.
    171. </summary>
    172. <returns>
    173. A double-precision floating point number greater than or equal to 0.0, and less than 1.0.
    174. </returns>
    175. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.NextDoubleEx">
    176. <summary>
    177. Returns a random number between 0.0 and 1.0.
    178. </summary>
    179. <returns>
    180. A double-precision floating point number greater than or equal to 0.0, and less than 1.0.
    181. </returns>
    182. <remarks>This Method uses a more sophistacted way to generate a Double</remarks>
    183. </member><member name="M:NTHLibrary.PseudoRNG.IRandom.Warmup">
    184. <summary>
    185. tOdO
    186. </summary>
    187. <remarks>
    188. Some PRNG need to "warm up" before they deliver good and/or reliable values. Warming up
    189. in this case means to run a certain number of rounds and discarding the results.
    190. </remarks>
    191. </member><member name="T:NTHLibrary.PseudoRNG.IRandom">
    192. <summary>
    193. The IRandom interface.
    194. </summary>
    195. <remarks>tOdO</remarks>
    196. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.Next">
    197. <inheritdoc/>
    198. <threadsafety static="true" instance="true"></threadsafety>
    199. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.Next(System.Int32)">
    200. <inheritdoc/>
    201. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.Next(System.Int32,System.Int32)">
    202. <inheritdoc/>
    203. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.NextDouble">
    204. <inheritdoc/>
    205. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.NextDoubleEx">
    206. <inheritdoc/>
    207. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.NextBytes(System.Byte[])">
    208. <inheritdoc/>
    209. </member><member name="M:NTHLibrary.PseudoRNG.SystemDefault.Warmup">
    210. <inheritdoc/>
    211. </member><member name="T:NTHLibrary.PseudoRNG.SystemDefault">
    212. <summary>
    213. This class uses the system's default implementation of the PRNG
    214. </summary>
    215. <remarks>Internally a new instance of <c>System.Random</c> is used for any thread, thus making calls to methods threadsafe</remarks>
    216. </member><member name="P:NTHLibrary.My.Resources.Resources.ResourceManager">
    217. <summary>
    218. Returns the cached ResourceManager instance used by this class.
    219. </summary>
    220. </member><member name="P:NTHLibrary.My.Resources.Resources.Culture">
    221. <summary>
    222. Overrides the current thread's CurrentUICulture property for all
    223. resource lookups using this strongly typed resource class.
    224. </summary>
    225. </member><member name="T:NTHLibrary.My.Resources.Resources">
    226. <summary>
    227. A strongly-typed resource class, for looking up localized strings, etc.
    228. </summary>
    229. </member><member name="M:NTHLibrary.ProcessExtensions.GetOwner(System.Diagnostics.Process)">
    230. <summary>
    231. Determines the owner of a certain process using WMI
    232. </summary>
    233. <param name="p">The process of which the owner should be determined</param>
    234. <returns>Ownername (including domain) as string</returns>
    235. <remarks>Original C# code: "http://stackoverflow.com/questions/777548/how-do-i-determine-the-owner-of-a-process-in-c"</remarks>
    236. </member><member name="M:NTHLibrary.IEnumerableExtensions.Random``1(System.Collections.Generic.IEnumerable{``0},System.Int32)">
    237. <summary>
    238. Returns an IEnumerable with <c>num</c> objects of <c>source</c> in random order
    239. </summary>
    240. <typeparam name="TSource">Generic type</typeparam>
    241. <param name="source">IEnumerable that contains the objects.</param>
    242. <param name="num">Number of objects to choose from source.</param>
    243. <returns>IEnumerable(Of TSource) in random order.</returns>
    244. <remarks></remarks>
    245. <threadsafety>A call to this method is threadsafe.</threadsafety>
    246. </member><member name="M:NTHLibrary.IEnumerableExtensions.Random``1(System.Collections.Generic.IEnumerable{``0},System.Int32,NTHLibrary.PseudoRNG.IRandom)">
    247. <summary>
    248. Returns an IEnumerable with <c>num</c> objects of <c>source</c> in random order.
    249. <c>rnd.Next()</c> is used to create the ordering.
    250. </summary>
    251. <typeparam name="TSource">Generic type</typeparam>
    252. <param name="source">IEnumerable that contains the objects.</param>
    253. <param name="num">Number of objects to choose from source.</param>
    254. <returns>IEnumerable(Of TSource) in random order.</returns>
    255. <remarks></remarks>
    256. <threadsafety>A call to this method is threadsafe, if <c>rnd.Next() is threadsafe.</c></threadsafety>
    257. </member><member name="M:NTHLibrary.IEnumerableExtensions.Random``1(System.Collections.Generic.IEnumerable{``0})">
    258. <summary>
    259. Returns an IEnumerable with all objects of <c>source</c> in random order
    260. </summary>
    261. <typeparam name="TSource">Generic type</typeparam>
    262. <param name="source">IEnumerable that contains the objects.</param>
    263. <returns>IEnumerable(Of TSource) in random order.</returns>
    264. <remarks></remarks>
    265. <threadsafety>A call to this method is threadsafe.</threadsafety>
    266. </member><member name="M:NTHLibrary.IEnumerableExtensions.RandomOrDefault``1(System.Collections.Generic.IEnumerable{``0})">
    267. <summary>
    268. Returns a random element of <c>source</c> or the default, if <c>source</c> is empty
    269. </summary>
    270. <typeparam name="TSource">Generic type</typeparam>
    271. <param name="source">IEnumerable that contains the objects.</param>
    272. <returns>A random element of <c>source</c></returns>
    273. <remarks></remarks>
    274. <threadsafety>A call to this method is threadsafe.</threadsafety>
    275. </member><member name="M:NTHLibrary.IEnumerableExtensions.Shuffle``1(System.Collections.Generic.IEnumerable{``0}@)">
    276. <summary>
    277. not implemented yet
    278. </summary>
    279. <typeparam name="TSource">Generic type</typeparam>
    280. <param name="source">IEnumerable that contains the objects.</param>
    281. <remarks>not implemented yet -&gt; should do the fisher yates shuffle in place</remarks>
    282. </member><member name="M:NTHLibrary.IEnumerableExtensions.Backup``1(System.Collections.Generic.ICollection{``0},System.IO.Stream,System.Predicate{``0})">
    283. <summary>
    284. Backups the items of an <c>ICollection</c> to a <c>Stream</c>
    285. </summary>
    286. <typeparam name="TSource">Generic Type</typeparam>
    287. <param name="source">The ICollection that contains the items to backup</param>
    288. <param name="strm">Stream to store the items</param>
    289. <param name="OnCondition">Optional. If set, can be used to limit the items to be
    290. backuped to those that match the given condition function</param>
    291. <returns>The number of items backuped.</returns>
    292. <remarks>?</remarks>
    293. </member><member name="M:NTHLibrary.IEnumerableExtensions.Backup``1(System.Collections.Generic.ICollection{``0},System.Byte[]@,System.Predicate{``0})">
    294. <inheritdoc cref="!:Backup(Of TSource)(ICollection(Of TSource), IO.Stream, Predicate(Of TSource)"/>
    295. <summary>
    296. Backups the items of an <c>ICollection</c> to a buffer
    297. </summary>
    298. <param name="buf">A buffer of Byte that takes the backuped items.</param>
    299. <remarks>?</remarks>
    300. </member><member name="T:NTHLibrary.IEnumerableExtensions">
    301. <summary>
    302. Extensions for IENumerable
    303. </summary>
    304. <remarks></remarks>
    305. </member>
    306. </members>
    307. </doc>


    Das ist zwar nicht gerade übersichtlich, aber aussageKRÄFTIGER als ein reines Klassendiagramm ist es allemal ...

    naja, ich denke mal, dass sich nur die wenigsten die mühe machen werden das alles zu lesen - ist ja doch recht kryptisch^^
    ich schätze es ist ausreichen eine auflistung zu machen, evtl noch die zu übergebenden werte aufzuschreiben

    ToString() as string
    GraphicsFromImage(byval img as bitmap) as graphics
    SaveToFile(byval Pfad as string)

    Auch, wenn es eine perfekte Beschreibung ist - das bezweifel' ich nicht - eine perfekte Beschreibung ist etwas anderes als eine Übersicht.

    Ich sehe gerade mein WPF-Buch vor mir. Das hat ~1200 Seiten. Eine perfekte Beschreibung. Aber für jemanden, der nur mal schnell wissen will, was für Vorteile WPF mit sich bringt und was generell bei WPF abgeht, ist das nicht das Richtige. Da reicht ein MSDN-Artikel.
    Von meinem iPhone gesendet

    Ich erwarte da eher was übersichtlicheres. Das XML-Konstrukt kann ja gerne noch zusätzlich gepostet werden.

    Es geht nur darum, dass man häufig absolut nicht weiß, was in der Bibliothek überhaupt drin steckt. Da steht dann nur "viele nützliche Funktionen".

    Eine simple Übersicht der Funktionsnamen würde schon reichen. Da kann man ja eigentlich alles wichtige rauslesen.
    Besucht auch mein anderes Forum:
    Das Amateurfilm-Forum