Jump to content

    

Как правильно писать Verilog file header или что не нравится ALINTy

///////////////////////////////////////////////////////////////////////
//  Abstract      : file.sv
//  Author        : me
//  By              : my company
//
//  Description  :
//  Abstract      :
//  History        :
//  Version        : 2.0
//  Date            : 25.03.2018
//  Change        : 25.03.2018
//  Modification  : 28.02.2019
///////////////////////////////////////////////////////////////////////

ALINT выдаёт:
# ALINT: Warning: D:/file.sv : (33, 1): "RMM.VLOG.5.2.4.1" Not all required tokens are present in the file header. Following token(s) are expected: "Abstract" (ABSTRACT), "Author" (AUTHOR), "By" (BY), "Change" (CHANGE), "Date" (DATA), "[0-9]+\/[0-9]+\/[0-9]+" (DATA_LITERAL), "Description" (DESCRIPTION), "\n" (END_LINE), "File" (FILE_NAME), "History" (HISTORY), "any_ASCII_characters" (IDENTIFIER), "[0-9]+" (INTEGER), "Modification" (MODIFICATION), ":" (SEPARATION_CHAR), "Version" (VERSION), "[0-9\.]+" (VERSION_LITERAL). Level: Recommendation 1.

Что не так, где посмотреть то, что написано в RMM.VLOG.5.2.4.1 и каков пример header-а Verilog (SV) файла?

Share this post


Link to post
Share on other sites

Всем спасибо, достаточно было почитать help:
 

// (C) Copyright 2010 Aldec, Inc.
//
// File        : mux.v
// Author      : Mr. Smith
// Date        : 03/21/10
// Version     : 1.0
// Abstract    : This file contains the behavioral description 
//                of the trigger
//
// Modification History :
// Date       By          Version   Change Description
//============================================================
// 11/05/09   Mr. Smith    1.0       Original
// 03/21/10   Bob Broun   1.1       Structural model is added 
//
//============================================================

Share this post


Link to post
Share on other sites

ИМХО, опасный в наше время, если сорцы наружу уйдут, хидер. Первую строку бы убрать.....

Share this post


Link to post
Share on other sites

Нужно задать file, так понимаю. Как и в doxygen. Второй исходник - это пример. 

upd. поправил название doxygen, путаю постоянно

Share this post


Link to post
Share on other sites
3 часа назад, ViKo сказал:

doxygen

Раз разговор его коснулся, что является комильфо для автоматизированного документирования проектов на HDL (особенно интересует SV) в настоящее время?
Я правильно задал вопрос?

Share this post


Link to post
Share on other sites

Я пишу согласно требованиям doxygen, но Verilog напрямую не поддерживается, вроде. То есть, сам dogygen я и не использую, не генерирую документацию ни для C, ни для чего-либо. Я и обычные текстовые файлы - заметки описываю подобными шапками. Чисто для общего стиля.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now