Соглашения о комментировании на Java [закрыто]

Вот как вы это делаете:

public class TheModel
{
    //Can be string, int, Guid, etc. Usually this is the index key.
    public int SelectedValue {get;set;} 
    public List TheList {get;set;}

    public TheModel()
    {
        TheList = new List();
    }
}

Например, у вас есть модель с индексным ключом типа int. Вы получаете его из базы данных и вставляете в список.

TheModel model = new TheModel();
using(MigrationDB db = new MigrationDB())
{
    model.TheList = db.Plane.Select(m => new SelectListItem()
                    {
                        Value = m.PlaneId.ToString(), //Value can hold only string
                        Text = m.PlaneName //this is the 
                    }.ToList();
}

Вот как вы пишете это в виде Razor:

@model TheModel

.....

//You can use Html.BeginForm() to create the form tag. @Html.DropDownListFor(m => m.SelectedValue, //This will bind the selected option into `SelectedValue` property Model.TheList, //This will fill up your

Так что если вы выберете опцию из выпадающего списка, она будет привязана к свойству SelectedValue.

[HttpPost]
public ActionResult PassTheValue(TheModel model) //Pass the entire model
{
    var theSelectedValue = model.SelectedValue;
    ...
}

Вы должны передать всю модель из представления HTML-страницы в контроллер.

Ссылка на Html.BeginForm() источник

22
задан Nitesh Verma 12 September 2013 в 05:41
поделиться

4 ответа

Прежде всего, наличие читаемого кода и читаемых комментариев - это две совершенно разные вещи.

Читаемый код - это код, использующий хорошую переменную, метод, имена классов и т. Д.

Читаемые комментарии - это скорее вопрос личного вкуса. Некоторые люди любят комментарии, чтобы следовать грамматическим правилам, которые будут использоваться для написания книги, в то время как другие не заботятся о грамматических вещах. Вы можете перейти по этой ссылке:

http://www.oracle.com/technetwork/java/codeconventions-141999.html#385

Из читаемого кода и комментарии, вы можете создавать документацию с помощью doxygen.

http://www.doxygen.nl/manual/docblocks.html

1
ответ дан 29 November 2019 в 05:35
поделиться

Стиль комментариев в вашем первом примере — это не просто соглашение, это стандарт для инструмента документации под названием Javadoc . Если вы будете следовать этому стилю комментирования Javadoc, вы сможете легко создавать документацию в формате html для всего вашего исходного кода.

1
ответ дан 29 November 2019 в 05:35
поделиться

Вот соглашения о кодировании Java для комментариев, рекомендованные Oracle:

Вот рекомендации Google для их платформы Android :

Для получения более подробной информации о стиле и соглашениях для Javadoc см. здесь:

21
ответ дан 29 November 2019 в 05:35
поделиться

Я бы просто следовал стандарту, определенному Sun (Oracle) для написания Javadoc. Javadoc единодушно упоминается всеми разработчиками :). Для получения дополнительной информации нажмите здесь

Я также прошу вас выполнить поиск в Stackoverflow для множества вопросов и ответов на комментарии.

https://stackoverflow.com/search?q=commenting

0
ответ дан 29 November 2019 в 05:35
поделиться
Другие вопросы по тегам:

Похожие вопросы: