您的.NET源代码文档中有多少是太多了?
一些背景:我继承了一个很大的代码库,我已经在SO上发布了一些其他问题.这个代码库的一个"特性"是God Class,一个包含大约3000行代码的单个静态类,包含几十个静态方法.这是一个从一切Utilities.CalculateFYBasedOnMonth()要Utilities.GetSharePointUserInfo()到Utilities.IsUserIE6().这些都是不需要重写的好代码,只需重构成一组适当的库.我已经计划好了.
由于这些方法正在进入一个新的业务层,我在这个项目中的角色是为其他开发人员准备系统以进行维护,我正在考虑可靠的代码文档.虽然这些方法都具有良好的内联注释,但它们并不都具有XML注释形式的良好(或任何)代码doco.使用GhostDoc和Sandcastle(或文档X)的组合,我可以创建一些非常好的HTML文档并将其发布到SharePoint,这将使开发人员更多地了解代码的作用,而无需浏览代码本身.
随着代码中文档量的增加,导航代码变得越困难.我开始怀疑XML注释是否会使代码更难以维护,比如说//comment每个方法更简单.
这些示例来自Document X示例:
/// <summary>
/// Adds a new %Customer:CustomersLibrary.Customer% to the collection.
/// </summary>
/// <returns>A new Customer instance that represents the new customer.</returns>
/// <example>
/// The following example demonstrates adding a new customer to the customers
/// collection.
/// <code lang="CS" title="Example">
/// CustomersLibrary.Customer newCustomer = myCustomers.Add(CustomersLibrary.Title.Mr, "John", "J", "Smith");
/// </code>
/// <code lang="VB" title="Example">
/// Dim newCustomer As CustomersLibrary.Customer …Run Code Online (Sandbox Code Playgroud) 如果我将元素插入到包装面板中,并且在下一行溢出之前面板中仍有空间,我可以专门将其包裹起来,以便后续元素在下一行吗?
我正在寻找这样的东西:
<WrapPanel>
<Element/>
<Element/>
<NewLine???/>
<Element/>
<Element/>
<Element/>
</WrapPanel>
Run Code Online (Sandbox Code Playgroud) 我是一名.NET开发人员,拥有大约5年的使用Microsoft技术的Web开发经验,从经典ASP到ASP .NET 3.5开始.
我也有一些Java背景,可以很容易地编写/理解Java代码.我正在寻找与我的.NET体验兼容的资源(在线,书籍).我只对Java中的Web开发感兴趣,并希望从中级开始,即使它可能需要我查找一些细节.
您建议中级.NET Web开发人员获得与Java Web开发工具相同的熟练程度的路径或资源是什么?
假设您所在的IT商店不允许使用任何类型的ORM工具.他们不想买一个,也不能使用开源解决方案.
你会怎么做?放弃真正的域模型并以工作表为中心?制作自己的DAL?
我正在开发一个WPF应用程序并且我非常了解命令模式,但我发现MVVM的命令模式有几种不同的实现.Josh Smith在他的WPF示例应用程序中实现,DelegateCommand来自Prism,以及CommandBindings实现.
我的问题是,使用MVVM命令的普遍接受的最佳做法是什么?我的应用程序使用Prism,因此DelegateCommand我们可以使用.
我团队的开发人员正在争论哪种方法"最好".有些人不喜欢为每个命令生成的众多.cs文件,有些人更喜欢通过连接所有内容CommandBindings.我不知所措.任何人都能解释一下吗?
我想在Windows 7下使用Windows Virtual PC测试我的WPF应用程序.在我的C#代码中,我正在检查WPF层,如果它小于2,我禁用了DirectX调用.为了在Windows XP上进行测试,我想使用Windows Virtual PC,但它似乎只能在软件模式下运行.因此,等级总是<2.
有关如何使DirectX在Virtual PC中工作的任何想法?
我想创建一个在左侧有一个列表框的应用程序(我会设置它以使其看起来很好).
在右侧,我想要一个可以添加控件等的区域
所以问题是我需要做什么才能将Window分成两个不相等的部分(左边约350像素宽,高度应该是整个窗口),其余部分是我的"画布".
假设您继承了一个C#代码库,该代码库使用一个具有200个静态方法的类来提供核心功能(例如数据库查找).在那个班级的许多噩梦中,有大量使用匈牙利符号(坏类型).
你会重构变量名来删除匈牙利表示法吗,还是会让他们独自一人?
如果您选择更改所有变量以删除匈牙利表示法,那么您的方法是什么?
我正在整理一个写入数据库的小型Web应用程序(Perl CGI和MySQL).CGI脚本从表单中获取一些信息并将其写入数据库.但是,我注意到,如果我在网络浏览器上点击"重新加载"或"返回",它会再次将数据写入数据库.我不想要这个.
在这种情况下,防止重写数据的最佳方法是什么?
我是Ruby on Rails的新手,到目前为止,我学到了很多乐趣.来自.NET世界,它是一个非常开关,因为我的IDE(Visual Studio 2008)为我处理一切,而在Rails中,一切都是通过多个应用程序(Terminal,TextMate等)完成的.
我已经开始仔细研究RubyMine作为Rails开发的IDE,作为IDEA和ReSharper的忠实粉丝,我自然喜欢RubyMine.它具有代码完成功能,内置支持RSpec,SVN集成等.但是,由于IDE处理了很多"Rails体验",我想知道是否应该坚持使用TextMate + Terminal方法.
像RubyMine这样的Ruby/Rails IDE会阻碍我吗?
wpf ×4
.net ×2
c# ×1
cgi ×1
coding-style ×1
command ×1
database ×1
directx ×1
ide ×1
idempotent ×1
java ×1
mvvm ×1
ndoc ×1
orm ×1
perl ×1
refactoring ×1
sandcastle ×1
virtual-pc ×1
xaml ×1
xml-comments ×1