Here&#39;s a citation of a no longer available, good article on documentation: 

&gt; The compiler team decided to improve
&gt; this by allowing an alternate syntax
&gt; to refer to generic types and methods
&gt; in doc comments.  Specifically,
&gt; instead of using the open and close
&gt; angle-brackets it’s legal to use the
&gt; open and close curly braces.  The
&gt; example above would then become:

    class Program
    {
        /// &lt;summary&gt;
        /// DoSomething takes a &lt;see cref=&quot;List{T}&quot;/&gt;
        /// &lt;/summary&gt;
        void DoSomething(List&lt;int&gt; al) { }
    }

So, in your case:

    ///&lt;see cref=&quot;name.space.typename{T}(paramtype)&quot;/&gt;

Here are a couple of newer references from Microsoft:

* [XML Documentation Comments (C# Programming Guide)][1]
* [Documenting your code with XML comments][2]

  [1]: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments
  [2]: https://docs.microsoft.com/en-us/dotnet/csharp/codedoc

Use curly brackets:

    ///&lt;see cref=&quot;name.space.typename{T}(paramtype)&quot;&gt;



Following on the heels of my other [question about mocking DbContext.Set&lt;T&gt;][1] I&#39;ve got another question about mocking EF Code First.

I now have a method for my update that looks like:

    if (entity == null)
        throw new ArgumentNullException(&quot;entity&quot;);
    
    Context.GetIDbSet&lt;T&gt;().Attach(entity);
    Context.Entry(entity).State = EntityState.Modified;
    Context.CommitChanges();
    
    return entity;

Context is an interface of my own DbContext.

The problem I&#39;m running in to is, how do I handle the

 `Context.Entry(entity).State`.

I&#39;ve stepped through this code and it works when I have a real live DbContext as the implementation of my Context interface.  But when I put my fake context there, I don&#39;t know how to handle it.

There is no constructor for a DbEntityEntry class, so I can&#39;t just create a new one in my fake context.

Has anyone had any success with either mocking or faking DbEntityEntry in your CodeFirst solutions?

Or is there a better way to handle the state changes?

  [1]: https://stackoverflow.com/questions/5007100/mocking-dbcontext-sett

Mocking or faking DbEntityEntry or creating a new DbEntityEntry

I guess using this pattern is the new hotness, but I don&#39;t understand what the advantage is and I don&#39;t understand the scoping implications.

The pattern:  
    
    (function(window, document, undefined){
      window.MyObject = {
        methodA: function() { ... },
        methodB: function() { ... }
      };
    })(window, document)

So I have several questions about this.

Is there a particular advantage to encapsulating an object like this?  
Why are _window_ and _document_ being fed in instead of just being accessed normally?  
Why the heck is `undefined` being passed in?  
Is attaching the object we&#39;re creating directly to window a particularly good idea?  

I&#39;m used to what I&#39;ll call the Crockford style of Javascript encapsulation (because I got it off the Douglas Crockford Javascript videos).

    NameSpace.MyObject = function() {
      // Private methods
      // These methods are available in the closure
      // but are not exposed outside the object we&#39;ll be returning.
      var methodA = function() { ... };
      
      // Public methods
      // We return an object that uses our private functions,
      // but only exposes the interface we want to be available.
      return {

        methodB: function() {
          var a = methodA();
        },
        methodC: function() { ... }

      }
    // Note that we&#39;re executing the function here.
    }();

Is one of these patterns functionally better than the other? Is the first one an evolution of the other?

What advantages does using (function(window, document, undefined) { ... })(window, document) confer?

As I know, in a XML comment for a C# type/method, it is possible to reference a generic type in a &lt;see&gt; tag like so: 

    ///&lt;see cref=&quot;name.space.typename&amp;lt;T&amp;rt;(paramtype)&quot;&gt;

But I think, there was another syntax, which is less clumsy? Something, to get rid of those html entities &#39;&amp;lt;&#39;? I cannot find it right now. Can somebody help?  

reference to generic type in XML code comment

As I know, in a XML comment for a C# type/method, it is possible to reference a generic type in a <see> tag like so:</see>
<pre><code class="hljs language-php-template">///&#x3C;see cref="name.space.typename&#x26;lt;T&#x26;rt;(paramtype)">
</code></pre>
But I think, there was another syntax, which is less clumsy? Something, to get rid of those html entities '&#x3C;'? I cannot find it right now. Can somebody help?


I have a requirement to test some load issues with regards to file size.  I have a windows application written in C# which will automatically generate the files.  I know the size of each file, ex. 100KB, and how many files to generate.  What I need help with is how to generate a string less than or equal to the required file size.

pseudo code:

    long fileSizeInKB = (1024 * 100); //100KB
    int numberOfFiles = 5;
    
    for(var i = 0; i &lt; numberOfFiles - 1; i++) {
         var dataSize = fileSizeInKB;
         var buffer = new byte[dataSize];
         using (var fs = new FileStream(File, FileMode.Create, FileAccess.Write)) {
    
         }
    }

 



How to generate string of a certain length to insert into a file to meet a file size criteria?

I want to use my `IsGPUBasedAttribute` for enum members like this:

    public enum EffectType
    {
    	[IsGPUBased(true)]
    	PixelShader,
    
    	[IsGPUBased(false)]
    	Blur
    }

but the compiler doesn&#39;t let me to use:

    [AttributeUsage (AttributeTargets.Enum, AllowMultiple = false)]

What is the right `AttributeTarget` value to limit the usage to enum members?

What AttributeTarget should I use for enum members?

I&#39;m using the following code from this answer https://stackoverflow.com/questions/32260/sending-email-in-net-through-gmail. The trouble I&#39;m having is adding an attachment to the email. How would I add an attachment using the code below?

    using System.Net.Mail;
    
    var fromAddress = new MailAddress(&quot;from@gmail.com&quot;, &quot;From Name&quot;);
    var toAddress = new MailAddress(&quot;to@example.com&quot;, &quot;To Name&quot;);
    const string fromPassword = &quot;fromPassword&quot;;
    const string subject = &quot;Subject&quot;;
    const string body = &quot;Body&quot;;
    
    var smtp = new SmtpClient
    {
        Host = &quot;smtp.gmail.com&quot;,
        Port = 587,
        EnableSsl = true,
        DeliveryMethod = SmtpDeliveryMethod.Network,
        UseDefaultCredentials = false,
        Credentials = new NetworkCredential(fromAddress.Address, fromPassword)
    };
    using (var message = new MailMessage(fromAddress, toAddress)
        {
            Subject = subject,
            Body = body
        })
    {
        smtp.Send(message);
    }

Thanks in advance.

Adding an attachment to email using C#

Why does this code not cause a deadlock?

       private static readonly object a = new object();

... 

       lock(a)
       {
          lock(a)
          {
             ....
          }
       }



Why do nested locks not cause a deadlock?

How do you dynamically switch WCF Web Service Reference URL path through config file ?

Dynamically switch WCF Web Service Reference URL path through config file

Having the following XML:

    &lt;node&gt;Text1&lt;subnode/&gt;text2&lt;/node&gt;

How do I select either the first or the second text node via XPath?

Something like this:

    /node/text()[2]

of course doesn&#39;t work because it&#39;s the merged result of every text inside the node.

XPath: select text node

I am getting XML from a web service.  Here is what the XML looks like:

    &lt;parent&gt;
        &lt;child&gt;
            Text
        &lt;/child&gt;
    &lt;/parent&gt;
    &lt;parent&gt;
        &lt;child&gt;
            &lt;grandchild&gt;
                Text
            &lt;/grandchild&gt;
            &lt;grandchild&gt;
                Text
            &lt;/grandchild&gt;
        &lt;/child&gt;
        &lt;child&gt;
            Text
        &lt;/child&gt;
    &lt;/parent&gt;
    
    etc.

And here is my C# code:

    StringBuilder output = new StringBuilder();
    
    // Create an XmlReader
    using (XmlReader reader = XmlReader.Create(new StringReader(xoResponse.@return)))
    {
        XmlWriterSettings ws = new XmlWriterSettings();
        //ws.Indent = true;
        using (XmlWriter writer = XmlWriter.Create(output, ws))
        {
            // Parse the file and display each of the nodes.
            while (reader.Read())
            {
                switch (reader.NodeType)
                {
                    case XmlNodeType.Element:
                        writer.WriteStartElement(reader.Name);
                        break;
                    case XmlNodeType.Text:
                        writer.WriteString(reader.Value);
                        break;
                    case XmlNodeType.XmlDeclaration:
                    case XmlNodeType.ProcessingInstruction:
                        writer.WriteProcessingInstruction(reader.Name, reader.Value);
                        break;
                    case XmlNodeType.Comment:
                        writer.WriteComment(reader.Value);
                        break;
                    case XmlNodeType.EndElement:
                        writer.WriteFullEndElement();
                        break;
                }
            }
        }
    }

I believe that the error is thrown on the second parent element.  How can I avoid this error?  Any help is greatly appreciated.![enter image description here](https://i.stack.imgur.com/rqIAW.jpg)

XML Error: There are multiple root elements

I&#39;m searching the java library for parsing XML (complex configuration and data files), I googled a bit but couldn&#39;t found other than dom4j (Seems like they are working on V2).. I have taken look at commons configuration but didn&#39;t like it, Other apache projects on XML seems under hibernation. I haven&#39;t evaluated dom4j by myself but just wanted to know - Does java has other (Good) open source xml parsing libraries? and how&#39;s your experience with dom4j?

After the @Voo&#39;s answer let me ask another one - Should I use java&#39;s built-in classes or any third-party library like dom4j.. What are the advantages?

Which is the best library for XML parsing in java

I have this code:

    XElement EcnAdminConf = new XElement(&quot;Type&quot;,
        new XElement(&quot;Connections&quot;,
        new XElement(&quot;Conn&quot;),
        // Conn.SetAttributeValue(&quot;Server&quot;, comboBox1.Text);
        // Conn.SetAttributeValue(&quot;DataBase&quot;, comboBox2.Text))),
        new XElement(&quot;UDLFiles&quot;)));
        // Conn.

How do I add attributes to `Conn`? I want to add the attributes I marked as comments, but if I try to set the attributes on `Conn` after defining `EcnAdminConf`, they are not visible.

I want to set them somehow so the XML looks like this:

    &lt;Type&gt;
      &lt;Connections&gt;
        &lt;Conn ServerName=&quot;FAXSERVER\SQLEXPRESS&quot; DataBase=&quot;SPM_483000&quot; /&gt; 
        &lt;Conn ServerName=&quot;FAXSERVER\SQLEXPRESS&quot; DataBase=&quot;SPM_483000&quot; /&gt; 
      &lt;/Connections&gt;
      &lt;UDLFiles /&gt; 
    &lt;/Type&gt;

How to put attributes via XElement

I&#39;m trying to use RestSharp to consume a web service. So far everything&#39;s gone very well (cheers to John Sheehan and all contributors!) but I&#39;ve run into a snag. Say I want to insert XML into the body of my RestRequest in its already serialized form (i.e., as a string). Is there an easy way to do this? It appears the .AddBody() function conducts serialization behinds the scenes, so my string is being turned into `&lt;String /&gt;`.

Any help is greatly appreciated!

EDIT: A sample of my current code was requested. See below --

    private T ExecuteRequest&lt;T&gt;(string resource,
                                RestSharp.Method httpMethod,
                                IEnumerable&lt;Parameter&gt; parameters = null,
                                string body = null) where T : new()
    {
        RestClient client = new RestClient(this.BaseURL);
        RestRequest req = new RestRequest(resource, httpMethod);

        // Add all parameters (and body, if applicable) to the request
        req.AddParameter(&quot;api_key&quot;, this.APIKey);
        if (parameters != null)
        {
            foreach (Parameter p in parameters) req.AddParameter(p);
        }

        if (!string.IsNullOrEmpty(body)) req.AddBody(body); // &lt;-- ISSUE HERE

        RestResponse&lt;T&gt; resp = client.Execute&lt;T&gt;(req);
        return resp.Data;
    }

How to add text to request body in RestSharp

Does documentation for C++ exist in Linux? I want something like the man pages of C.
For example, docs for string, stl, iostream, ifstream, etc.?

Where are the man pages for C++?

I am currently beginning with Python and I have a strong PHP background and in PHP I have took the habit of using `javadoc` as a documentation template.

I was wondering if `javadoc` has its place as `docstring` documentation in Python. **What are the established conventions and/or official guildelines here?**

E.g. is something like this too elaborate to fit in the Python mindset or should I try to be as concise as possible?

    &quot;&quot;&quot;
    replaces template place holder with values
    
    @param string timestamp     formatted date to display
    @param string priority      priority number
    @param string priority_name priority name
    @param string message       message to display
    
    @return string formatted string
    &quot;&quot;&quot;

And if I am a bit too exhaustive should I go with something like this instead (where most of the documentation doesn&#39;t get printed through the `__doc__` method)?

    # replaces template place holder with values
    #    
    # @param string timestamp     formatted date to display
    # @param string priority      priority number
    # @param string priority_name priority name
    # @param string message       message to display
    #    
    # @return string formatted string

    def format(self, timestamp = &#39;&#39;, priority = &#39;&#39;, priority_name = &#39;&#39;, message = &#39;&#39;):
        &quot;&quot;&quot;
        replaces template place holder with values
        &quot;&quot;&quot;
        values = {&#39;%timestamp%&#39; : timestamp,
                  &#39;%priorityName%&#39; : priority_name,
                  &#39;%priority%&#39; : priority,
                  &#39;%message%&#39; : message}
        
        return self.__pattern.format(**values)


Using javadoc for Python documentation

I have just recently started playing with event-driven architectures, coming from a pretty standard object-oriented mindset.

The first thing I noticed was that the difficulty in understanding and tracing through programs seems to increase exponentially with the size of the program. While small pet projects are easy to follow, it feels like the code will rapidly turn to spaghetti.

I understand that I am new to this development mindset and not all of my object oriented worries carry over. Are there any resources on writing maintainable, understandable event-driven code? What do people who use node.js or Twisted or Event Machine do about this?

Writing Maintainable Event-Driven Code

I&#39;m looking for a way to **generate documentation automatically from my Javascript project**. Anyone know how can I do this?

As far as I know, there&#39;re some tools like [JSDoc][1] but I want to know your opinion, your best choice and why.

Thanks!

EDIT: just to be clear, I need something like JavaDOC or PHPDocumentor but to use with my Javascript source code.


  [1]: http://code.google.com/p/jsdoc-toolkit/

Generating Javascript documentation

It&#39;s easy to document a class or method in Python:

    class Something:
      &quot;&quot;&quot; Description of the class. &quot;&quot;&quot;
    
      def do_it(self):
        &quot;&quot;&quot; Description of the method. &quot;&quot;&quot;
        pass
    
      class_variable = 1 # How to comment?
    
      @property
      def give_me_some_special_dict(self):
        &quot;&quot;&quot; doesn&#39;t work! Doc of general dict will be shown. &quot;&quot;&quot;
        return {}

But how to document a field or property for usage in API docs or `help`? 

How to document fields and properties in Python?

What is the difference between an object, instance, and reference? They say that they have to create an instance to their application? What does that mean?


What exactly is an instance in Java?

I&#39;m new to MongoDB--coming from a relational database background. I want to design a question structure with some comments, but I don&#39;t know which relationship to use for comments: `embed` or `reference`?

A question with some comments, like [stackoverflow](https://stackoverflow.com/), would have a structure like this:

    Question
        title = &#39;aaa&#39;
        content = bbb&#39;
        comments = ???

At first, I want to use embeded comments (I think `embed` is recommended in MongoDB), like this:

    Question
        title = &#39;aaa&#39;
        content = &#39;bbb&#39;
        comments = [ { content = &#39;xxx&#39;, createdAt = &#39;yyy&#39;}, 
                     { content = &#39;xxx&#39;, createdAt = &#39;yyy&#39;}, 
                     { content = &#39;xxx&#39;, createdAt = &#39;yyy&#39;} ]

It clear, but I&#39;m worried about this case: **If I want to edit a specified comment, how do I get its content and its question?** There is no `_id` to let me find one, nor `question_ref` to let me find its question. (I&#39;m so newbie, that I don&#39;t know if there&#39;s any way to do this without `_id` and `question_ref`.)

Do I have to use `ref` not `embed`? Then I have to create a new collection for comments?

MongoDB relationships: embed or reference?

I found these symbols in a function declaration several times, but I don&#39;t know what they mean.

**Example:**

    void raccogli_dati(double **&amp; V, double **p, int N) { 
      int ultimo = 3; 
      V = new double * [N/2]; 
      for(int i=0; i &lt; N/2; i++) { 
        V[i] = new double[N/2], std :: clog &lt;&lt; &quot;digita &quot; &lt;&lt; N/2 - i
                     &lt;&lt; &quot; valori per la parte superiore della matrice V: &quot;; 
        for(int j=i; j &lt; N/2; j++) 
          std :: cin &gt;&gt; V[i][j], p[ultimo++][0] = (V[i][j] /= sqrt(p[i][0]*p[j][0]));
      } 
      for(int i=1; i &lt; N/2; i++) 
        for(int j=0; j &lt; i; j++) 
           V[i][j] = V[j][i];
    }


Meaning of *&amp; and **&amp; in C++

suppose I have the following datastructure:

    var user = {_id: &#39;foo&#39;, age: 35};
    var post = {_id: &#39;...&#39;, author: {$ref: user, $id: &#39;foo&#39;},...};

How can I query all posts which references user[foo]? I tried the following but not work:

    db.post.find(&#39;author._id&#39;: &#39;foo&#39;);
    var u = db.user.find({_id: &#39;foo&#39;});
    db.post.find(&#39;author&#39;: u);

neither can I find the answer from the official document and google!

Anyone has any idea?

How to query mongodb with DBRef

I have read that .NET supports return of references, but C# doesn&#39;t. Is there a special reason? Why I can&#39;t do something like:

    static ref int Max(ref int x, ref int y) 
    { 
      if (x &gt; y) 
        return ref x; 
      else 
        return ref y; 
    } 

Why doesn&#39;t C# support the return of references?

Requirement: In an unsorted List, determine if a duplicate exists.  The typical way I would do this is an n-squared nested loop.  I&#39;m wondering how others solve this.  Is there an elegant, high performance method in Linq?  Something generic that takes a lambda or a comparer would be nice. 

C# Determine Duplicate in List

Can somebody please explain me why I can&#39;t cast `List&lt;&gt;` to `ArrayList&lt;&gt;` with first approach and I do with second one? Thank you.

First approach:

    ArrayList&lt;Task&gt; tmp = ((ArrayList&lt;Task&gt;)mTrackytAdapter.getAllTasks(token));

 

Second approach:

    ArrayList&lt;Task&gt; tmp = new ArrayList&lt;Task&gt;(mTrackytAdapter.getAllTasks(token));

How to cast ArrayList&lt;&gt; from List&lt;&gt;

I was wondering what is the difference between the following two method declarations:

    public Object doSomething(Object obj) {....}
    
    public &lt;T&gt; T doSomething(T t) {....}

Is there something you can/would do with one but not the other?  I could not find this question elsewhere on this site.

Java generics T vs Object

I have come across a curious situation involving static generic methods. This is the code:

    class Foo&lt;E&gt;
    {
        public static &lt;E&gt; Foo&lt;E&gt; createFoo()
        {
            // ...
        }
    }
    
    class Bar&lt;E&gt;
    {
        private Foo&lt;E&gt; member;
    
        public Bar()
        {
            member = Foo.createFoo();
        }
    }

How come I don&#39;t have to specify any type arguments in the expression `Foo.createFoo()`? Is this some kind of type inference? If I want to be explicit about it, how can I specify the type argument?

Calling static generic methods

I don&#39;t understand why the following does not work:

    public void doSomething(int... args){
      List&lt;Integer&gt; broken = new ArrayList&lt;Integer&gt;(Arrays.asList(args))
    }

Its my understanding that the compiler converts the &quot;int... args&quot; to an array, so the above code should work.

Instead of working I get:
&gt;cannot find symbol
&gt;symbol:   constructor ArrayList(java.util.List`&lt;int[]`&gt;)
&gt;location: class java.util.ArrayList`&lt;java.lang.Integer`&gt;

Thats bizarre. I&#39;m not adding an array to array list, I&#39;m adding each element from the list to the arraylist. Whats going on?

Content Type	Original Author	Original Content on Stackoverflow
Question	user492238	View Question on Stackoverflow
Solution 1 - C#	Metro Smurf	View Answer on Stackoverflow
Solution 2 - C#	John Saunders	View Answer on Stackoverflow

reference to generic type in XML code comment

C# Problem Overview

C# Solutions

Solution 1 - C#

Solution 2 - C#

What advantages does using (function(window, document, undefined) { ... })(window, document) confer?

Mocking or faking DbEntityEntry or creating a new DbEntityEntry

Attributions