约定总结和参数文本？

对于撰写摘要和参数文本，是否有一个最佳实践，你需要了解多少细节，是否使用完整的句子，或者其他什么？我正在寻找一些良好的习惯来建立，因为我开始使用这些更多。谢谢！约定总结和参数文本？

public class JustinBieber{ 
    private readonly bool HasTalent; 
    JustinBieber(){ 
     HasTalent = false; 
    } 

    /// <summary> 
    /// JustinBieber object sings a song in specified style 
    /// </summary> 
    /// <param name="songName">The song to be sung</param> 
    /// <param name="style">The style in which the song is sung</param> 
    public void SingSong(string songName, string style){ 
     ... 
    } 
}

来源

2011-02-17 sooprise

Jon Skeet的主页有一个指向Java代码约定页面@oracle的链接，它简要地讨论了这一点，当然也适用于Java。 http://www.yoda.arachsys.com/java/ – 2011-02-17 17:02:48

我的经验在这里的规则是使用足够的细节，明确传达的意思，并没有更多的。

我更喜欢这里的简洁 - 感觉这一点尤其重要，因为XML文档用于智能感知。很长时间的评论往往不容易看到，所以我会避免这些评论，并在需要时将“更长”的评论放入<remarks>。

来源

2011-02-17 17:04:26

约定总结和参数文本？

回答

相关问题