| |
| A friend had told me about Sandcastle and I looked it up. Sandcastle is a project by Microsoft, that is intended to create MSDN-style documentation from .NET assemblies… I had managed to achieve my goal quite easily using Sandcastle, and I thought about sharing my experience to serve other people as a guide. This is just a quick write-up of what I did – I did not read Sandcastle’s documentation and I believe that I don’t know how to operate it to its full potential. 1. The first step is to download and install Sandcastle. 2. Next, if you haven’t done it already, you have to tell Visual Studio to build XML documentation files. This parses all your comments ( in the C# format /// etc…) and creates an XML file that we will feed into Sandcastle. To enable XML documentation, you have to go to Proect->(Project Name) Properties… and tick the relevant checkbox in the Build menu:builddoc
 3. We will now launch the Sandcastle GUI application, located in C:\Program Files\Sandcastle\Examples\generic ( replace C:\Program Files with wherever you had installed Sandcastle). 4. Add your assemblies (exe/dll) and XML comments file to the relevant list boxes and choose the desired output format. Enter you project name under “Name”. 5. Hit “Build”. The build process can take a while, and it may seem like the program is frozen, but it’s not. 6. Your documentation files should now be ready in C:\Program Files\Sandcastle\Examples\Your Project Name 7. If you chose CHM as an output format, you will now have to compile the CHM file. To do this you need to download and install Microsoft HTML Help Workshop 8. After installing HTML Help Workshop, you will have to run hhc.exe (from the directory where you installed it). hhc takes an hhp (HTML Help Project) file as an argument. Sandcastle has created this hhp file for you, and it should be in your Sandcastle project directory. Just run “hhc yourproject.hhp” and this will produce a CHM file in the project’s directory.
That’s it. You should now have your compiled CHM help file with nice MSDN-style documentation.
As I mentioned earlier, I don’t really know Sandcastle and will be happy to get some tips in the comments section if you have any.
From here: http://www.bonf.net/2009/03/04/create-c-documentation-using-sandcastle/ | |
|
| It’s Not TDD, It’s Design By Example The word “test” in software is a very loaded term. The first time I came across a tester (as in, a person performing the quality assurance role) was in my first professional job. We were never taught about testing at college, as we were all there to learn to be “developers”. It turns out there are lots of different kinds of testing. In a series of blog posts titled Agile Testing Directions, Brian Marick came up with a 2x2 matrix of test types, and describse the activities which happen in each corner of the matrix. If you haven’t read the blog posts, they can help to provide a vocabulary about the kinds of testing that most software teams undertake. ( Read more... )http://bradwilson.typepad.com/blog/2009/04/its-not-tdd-its-design-by-example.htmlhttp://www.exampler.com/old-blog/2004/05/26/#directions-toc | |
|
| 60 лет назад, весной 1949 года, чертежи самого первого советского компьютера МЭСМ стали облекаться в железо. Спустя полтора года, в январе 1951-го, правительственная комиссия подписала акт о приемке этой машины. Так с кибернетики было снято клеймо «продажной девки империализма». Опоздали: западные конкуренты быстро уходили вперед, а «железный занавес» обрек советские разработки на забвение. Что было, что могло быть — разбирался The New Times Юрий Панчул Принцип устройства компьютера общего назначения практически не изменился с 1946 года, когда американец Джон фон Нейман¹ опубликовал статью, в которой описал дизайн электронной машины. В историю это вошло как «архитектура фон Неймана». Статья основывалась на реальном компьютере ENIAC и EDVAC, архитектура которого была разработана в Университете Пенсильвании Преспером Экертом и Джоном Мочли в 1943–1947 годах. Одной из причин, почему «архитектура фон Неймана» не была названа именами его разработчиков, заключалась в том, что проект ENIAC/EDVAC финансировался армией США и был засекречен. ( Read more... ) | |
|
| http://en.csharp-online.net/AttributesContents * 1 Attribute usage and syntax * 2 Positional parameters * 3 Named parameters * 4 Using multiple attributes * 5 Target type * 6 Predefined attributes * 7 Custom attributes o 7.1 Creating a Custom Attribute Class o 7.2 Assigning the AttributeUsageAttribute to your class o 7.3 Creating positional parameters o 7.4 Creating named parameters * 8 Reflecting on attributes * 9 MSDN references * 10 See also | |
|
| Российская промышленность обновилась новым суперкомпьютером НПО "Сатурн" запустило в эксплуатацию самый мощный на текущий момент суперкомпьютер на территории России: 14,7 Тфлопс, производитель - IBM, Крок. Если мне не изменяет память, это второй кластер за два года, первый строило HP. Проект ГТД 5го поколения. Вообщем-то это не один двигатель, а целое семейство, которое пойдёт не только в авиацию, но и во флот и энергетику. А это тематическая картинка, то ради чего всё собственно затевается: ( Read more... ) | |
|
| What Is Software Design: 13 Years Later By Jack W. Reeves Published February 23, 2005 This is Part Two of Code As Design: Three Essays by Jack W. Reeves. Click here for the introduction. People have occasionally asked whether I did any follow-on writing to my "What Is Software Design" article. The answer has basically been "No, not really." I want to make it clear that that is not because I forgot about it or otherwise changed my mind. Allow me to offer a bit of explanation. When the article appeared, I hoped–actually expected–that I would get some type of rebuttal from some sort of industry "expert." I was looking forward to this since part of my reason for writing the article had been hopes of stimulating discussion within the software industry about the overall software development process. Nothing happened. ( Read more... )http://www.developerdotstar.com/mag/articles/reeves_design_main.html | |
|
| What Is Software Design? By Jack W. Reeves Published February 23, 2005 This is Part One of Code As Design: Three Essays by Jack W. Reeves. Click here for the introduction. This essay first appeared in the Fall, 1992 issue of C++ Journal. Object oriented techniques, and C++ in particular, seem to be taking the software world by storm. Numerous articles and books have appeared describing how to apply the new techniques. In general, the questions of whether O-O techniques are just hype have been replaced by questions of how to get the benefits with the least amount of pain. Object oriented techniques have been around for some time, but this exploding popularity seems a bit unusual. Why the sudden interest? ( Read more... )http://www.developerdotstar.com/mag/articles/reeves_design.html | |
|
|