Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explanation for Builder class in example #15

Merged
merged 2 commits into from
Apr 5, 2018
Merged

Add explanation for Builder class in example #15

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12b983a
Add explanation for Builder class in example
nopppers Mar 3, 2018
96345f5
Update Builder class comment based on feedback
nopppers Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion samples/BuilderApp/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ private static void Usage()
}
}

// Class for performing the project build
// The Microsoft.Build dlls needed from within aren't loaded until after the class is instantiated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually more fine-grained. Assemblies get loaded just in time to call the first method that uses them. I tried to find documentation on this, but didn't find anything official. This StackOverflow answer quotes a book explanation:

In the CLR, loading typically is triggered by the just in time (JIT) compiler based on types. When the JIT compiler tries to convert a method body from CIL to machine code, it needs access to the type definition of the declaring type as well as the type definitions for the type's fields.

Can you update this to something like

The Microsoft.Build namespaces must be referenced from a method that is called after RegisterInstance so that it has a chance to change their load behavior. Here, we put them into a separate class.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, a minor nit: the "C#-y" way to comment this would be in the form of an XML doc comment, something like

/// <summary>
/// Class for performing the project build
/// </summary>
/// <remarks>
/// This is in a separate class because ...
/// </remarks>

public class Builder
{
public bool Build(string projectFile)
Expand Down Expand Up @@ -133,4 +135,4 @@ public void Shutdown()
public string Parameters { get; set; }
}
}
}
}